From 550333acfd774046973ffcd64a4db88e20814634 Mon Sep 17 00:00:00 2001 From: Saunak <76943154+Saunakghosh10@users.noreply.github.com> Date: Sun, 16 Jul 2023 00:20:32 +0530 Subject: [PATCH] README with improved format and appealing content --- README.md | 68 +++++++++++++++++++++++-------------------------------- 1 file changed, 28 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 37e0d12..ec6960b 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,46 @@ # Your First Open Source Project -- New to Open Source Projects & not sure where to begin? -- Fret not! -- Contribute to your very first open source project in this beginner-friendly code repository! +Welcome to Your First Open Source Project, a beginner-friendly code repository where you can make your first contribution to an open source project. Our mission is to provide a safe and supportive space for everyone on their journey to becoming software developers. Whether you're new to coding or looking to gain experience in open source, this is the perfect place to start. -## Our Mission +## How to Contribute? -Our mission is to provide a safe space to support everyone on their journey to become software developers 👨‍💻 +Contributing is easy! Just follow these simple steps: -## How to contribute? +1. **Fork this repository**: Start by forking this repository to your own GitHub account. This will create a copy of the project under your account. +2. **Add your details**: Open the `CONTRIBUTORS.md` file and add your GitHub username and a link to your GitHub profile. This will ensure you get proper credit for your contribution. +3. **Submit a pull request**: Once you've made your changes, submit a pull request (PR) to the main repository. Our team will review your PR, provide feedback if necessary, and merge it into the main project once approved. +4. **Review and revise**: If there are any issues or suggestions with your PR, our admins will leave comments for you to address. Make the necessary revisions and resubmit your changes. -1. Fork this code repository. -2. Add your Github username and Github profile link in the CONTRIBUTORS.md file. -3. Submit a PR. -4. Wait for your PR to be reviewed, approved & merged by an admin/owner. -5. If there are issues with your PR, please revise them in accordance to the comments made by the admins. +## How to Join the Organization? -## How to join this organization? +If you're interested in joining our organization, follow these steps: -1. To indicate your interest in joining this organization, kindly do the following: - - **Go to the 'Issues' tab** - - **Click on the 'New issue' button** - - **Raise an issue titled 'Invitation to Your First Open Source Project Organization'** -2. Once you've submitted an issue, the GitHub Actions Bot will will send an invitation link to your email for you to join the organization. -3. Kindly check your email and accept the invitation to join our organization. -4. After joining this organization, please do the following: - - Star this repo - - Submit a PR containing your name & GitHub profile link in CONTRIBUTORS.md (if you haven't done so yet) - - Next, click [here](https://github.com/Your-First-Open-Source-Project) - - Then click on 'People' tab - - Next, toggle your organization visibility from 'Private' to 'Public' -5. Admins/Owners of the organization are free to invite any other GitHub users to the organization. +1. **Raise an issue**: Go to the "Issues" tab in this repository and click on the "New issue" button. Create a new issue titled "Invitation to Your First Open Source Project Organization" to indicate your interest in joining. +2. **Accept the invitation**: Once you've submitted the issue, the GitHub Actions Bot will send an invitation link to your email. Check your email and accept the invitation to join our organization. +3. **Complete the onboarding**: After joining the organization, please star this repository and submit a PR to the `CONTRIBUTORS.md` file with your name and GitHub profile link (if you haven't done so already). Then, go to [our organization page](https://github.com/Your-First-Open-Source-Project), click on the "People" tab, and toggle your organization visibility from "Private" to "Public". -## Status +## Current Status -- You can start submitting your contributions/PRs right now ^^ -- Also, feel free to **follow me** on GitHub, **star** this repository, **share** it with your friends. +- You can start submitting your contributions and pull requests right away! +- Don't forget to **follow us** on GitHub and **star** this repository to show your support. +- Feel free to share this project with your friends and encourage them to join as well. -## To Do's (KIV) +## Future Plans -> **Note** -> -> - Think of new open source code repositories which members can contribute to. -> - Possible ideas: -> - Enhance existing Community Website built using either Next.js & TypeScript with new features / pages 🌐 -> - A beginner-friendly code repository where newcomers write their first "Hello World" program 👋 -> - A educational code repository consolidating various JavaScript/Python mini projects & various programming resources/cheatsheets 📚 +We have some exciting plans for the future. Here are a few ideas we're considering: -## Hacktoberfest 2022 +- Enhancing our existing community website with new features and pages using technologies like Next.js and TypeScript. +- Creating a beginner-friendly code repository where newcomers can write their first "Hello World" program and learn the basics of coding. +- Building an educational code repository with various JavaScript and Python mini-projects, along with programming resources and cheat sheets. + +Stay tuned for updates on these projects! -Great news everyone, we are participating in Hacktoberfest 2022 & building our very own community website 🥳! +## Hacktoberfest 2022 -If you would like to contribute to this community-driven intiative, head over [here](https://github.com/Your-First-Open-Source-Project/main-website) and start submitting your PRs now 🎉 +We are thrilled to announce that we will be participating in Hacktoberfest 2022! Join us in building our very own community website and contribute to this community-driven initiative. Head over to [our Hacktoberfest repository](https://github.com/Your-First-Open-Source-Project/main-website) to start submitting your pull requests and be a part of the celebration! ## Credits -- Organization logo created by freepik - www.freepik.com +- Organization logo created by freepik - [www.freepik.com](https://www.freepik.com/vectors/html) + +We can't wait to see your contributions and support you on your open source journey. Happy coding!