-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
A better read me and made it easier to contribute to the read me #4883
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8fe559a
A better read me and made it easier to contribute to the read me
coderzawad a08d461
Merge branch 'gh-pages' into patch-1
coderzawad ec6da85
Merge branch 'gh-pages' into patch-1
shiftkey cb10ad9
Merge branch 'gh-pages' into patch-1
coderzawad 1ec8aa3
Merge branch 'gh-pages' into patch-1
coderzawad 12f7523
Merge branch 'gh-pages' into patch-1
coderzawad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,97 @@ | ||
| [up-for-grabs.net](https://up-for-grabs.net/) | ||
|  | ||
| # Up-For-Grabs | ||
|
|
||
| [](https://github.com/up-for-grabs/up-for-grabs.net/actions) | ||
| [](https://app.netlify.com/sites/up-for-grabs-test-bench/deploys) | ||
| [](#contributors) | ||
| ================ | ||
|
|
||
| <a href="https://up-for-grabs.net/"><img width="814" src="https://user-images.githubusercontent.com/359239/67390578-50f83a00-f573-11e9-835d-02eb9e019afb.png"></a> | ||
|
|
||
| This repository contains the content for the [Up-For-Grabs website](https://up-for-grabs.net/), a list of projects with curated tasks for new contributors. | ||
|
|
||
| ## List your project | ||
|
|
||
| If you know of or own a project that should be listed on Up for Grabs, | ||
| [follow the instructions to open a pull request](docs/list-a-project.md). | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you would like to get involved with the project, please read the | ||
| [CONTRIBUTING.md](.github/CONTRIBUTING.md) file as it contains: | ||
|
|
||
| - Instructions about getting your environment setup | ||
| - Guidance for testing locally | ||
| - Commands to run to verify changes | ||
|
|
||
| ## How does the site work? | ||
|
|
||
| If you want to learn more about the various parts of the Up-for-Grabs project, | ||
| the [How it works](docs/how-it-works.md) document is a good overview. | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| Thanks to these wonderful people who have improved the code and documentation to help this project grow. ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/filipe-gomes"><img src="https://avatars1.githubusercontent.com/u/42053052?v=4?s=100" width="100px;" alt="Filipe Magalhaes Gomes"/><br /><sub><b>Filipe Magalhaes Gomes</b></sub></a><br /><a href="#content-filipe-gomes" title="Content">🖋</a></td> | ||
| <td align="center"><a href="https://mkkhedawat.github.io/"><img src="https://avatars2.githubusercontent.com/u/5137374?v=4?s=100" width="100px;" alt="Manish Kumar Khedawat"/><br /><sub><b>Manish Kumar Khedawat</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=mkkhedawat" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/SpaceEEC"><img src="https://avatars1.githubusercontent.com/u/24881032?v=4?s=100" width="100px;" alt="SpaceEEC"/><br /><sub><b>SpaceEEC</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=SpaceEEC" title="Code">💻</a></td> | ||
| <td align="center"><a href="http://www.joaomanoel.com.br"><img src="https://avatars0.githubusercontent.com/u/6238111?v=4?s=100" width="100px;" alt="João Manoel Lins"/><br /><sub><b>João Manoel Lins</b></sub></a><br /><a href="#content-JoaoManoel" title="Content">🖋</a></td> | ||
| <td align="center"><a href="https://github.com/crystal-dawn"><img src="https://avatars3.githubusercontent.com/u/38540136?v=4?s=100" width="100px;" alt="Crystal Yungwirth"/><br /><sub><b>Crystal Yungwirth</b></sub></a><br /><a href="#content-crystal-dawn" title="Content">🖋</a></td> | ||
| <td align="center"><a href="https://github.com/TeslaAdis"><img src="https://avatars1.githubusercontent.com/u/20220542?v=4?s=100" width="100px;" alt="Adis Talic"/><br /><sub><b>Adis Talic</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=TeslaAdis" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/AstroBoogie"><img src="https://avatars2.githubusercontent.com/u/18710598?v=4?s=100" width="100px;" alt="Nathaniel Adams"/><br /><sub><b>Nathaniel Adams</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=AstroBoogie" title="Code">💻</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="http://ishan.co"><img src="https://avatars0.githubusercontent.com/u/1873271?v=4?s=100" width="100px;" alt="Ishan Sharma"/><br /><sub><b>Ishan Sharma</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=ishansharma" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/firfircelik"><img src="https://avatars0.githubusercontent.com/u/34511698?v=4?s=100" width="100px;" alt="Firat Celik"/><br /><sub><b>Firat Celik</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=firfircelik" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/phncosta"><img src="https://avatars0.githubusercontent.com/u/47827714?v=4?s=100" width="100px;" alt="Paulo H. Costa"/><br /><sub><b>Paulo H. Costa</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=phncosta" title="Documentation">📖</a></td> | ||
| <td align="center"><a href="https://github.com/XxZhang2017"><img src="https://avatars2.githubusercontent.com/u/26696836?v=4?s=100" width="100px;" alt="XxZhang2017"/><br /><sub><b>XxZhang2017</b></sub></a><br /><a href="#content-XxZhang2017" title="Content">🖋</a> <a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=XxZhang2017" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://chadwhitacre.com/"><img src="https://avatars2.githubusercontent.com/u/134455?v=4?s=100" width="100px;" alt="Chad Whitacre"/><br /><sub><b>Chad Whitacre</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=chadwhitacre" title="Documentation">📖</a></td> | ||
| <td align="center"><a href="https://github.com/Jai2305"><img src="https://avatars.githubusercontent.com/u/47395196?v=4?s=100" width="100px;" alt="Jai "/><br /><sub><b>Jai </b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=Jai2305" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/jalaniz1"><img src="https://avatars.githubusercontent.com/u/1664815?v=4?s=100" width="100px;" alt="James Alaniz"/><br /><sub><b>James Alaniz</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=jalaniz1" title="Code">💻</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/gewarren"><img src="https://avatars.githubusercontent.com/u/24882762?v=4?s=100" width="100px;" alt="Genevieve Warren"/><br /><sub><b>Genevieve Warren</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=gewarren" title="Documentation">📖</a></td> | ||
| <td align="center"><a href="https://github.com/SaadAnsari17"><img src="https://avatars.githubusercontent.com/u/94478736?v=4?s=100" width="100px;" alt="Saad"/><br /><sub><b>Saad</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=SaadAnsari17" title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/JeetPatel1016"><img src="https://avatars.githubusercontent.com/u/60153965?v=4?s=100" width="100px;" alt="Jeet Patel"/><br /><sub><b>Jeet Patel</b></sub></a><br /><a href="https://github.com/up-for-grabs/up-for-grabs.net/commits?author=JeetPatel1016" title="Code">💻</a></td> | ||
| </tr> | ||
| </tbody> | ||
| <tfoot> | ||
|
|
||
| </tfoot> | ||
| </table> | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! | ||
|
|
||
| ## About | ||
|
|
||
| Up-For-Grabs is a platform that connects open source projects with new contributors. We maintain a curated list of tasks that are specifically designed for newcomers to open source development. Visit our [website](https://up-for-grabs.net/) to find your next contribution opportunity! | ||
|
|
||
| ## Quick Links | ||
|
|
||
| - 🌐 [Browse Projects](https://up-for-grabs.net/) | ||
| - 📝 [List Your Project](docs/list-a-project.md) | ||
| - 🤝 [Contribution Guidelines](.github/CONTRIBUTING.md) | ||
| - 📘 [How It Works](docs/how-it-works.md) | ||
|
|
||
| ## For Project Maintainers | ||
|
|
||
| ### Adding Your Project | ||
|
|
||
| 1. Ensure your project has: | ||
| - Clear documentation for newcomers | ||
| - Tasks labeled specifically for new contributors | ||
| - Active maintainers to review submissions | ||
|
|
||
| 2. [Follow our guide](docs/list-a-project.md) to submit your project through a pull request | ||
|
|
||
| 3. Tag your issues with labels like "up-for-grabs", "good first issue", or "help wanted" | ||
|
|
||
| ## For Contributors | ||
|
|
||
| ### Getting Started | ||
|
|
||
| 1. **Find a Project**: Browse our [website](https://up-for-grabs.net/) to find projects that interest you | ||
|
|
||
| 2. **Select a Task**: Look for issues tagged as beginner-friendly | ||
|
|
||
| 3. **Make a Contribution**: Follow the project's contribution guidelines to submit your work | ||
|
|
||
| ### Contributing to Up-For-Grabs | ||
|
|
||
| Want to improve Up-For-Grabs itself? Here's how: | ||
|
|
||
| 1. **Setup Your Environment** | ||
| ```bash | ||
| git clone https://github.com/up-for-grabs/up-for-grabs.net.git | ||
| cd up-for-grabs.net | ||
| # Follow setup instructions in CONTRIBUTING.md | ||
| ``` | ||
|
|
||
| 2. **Run Tests Locally** | ||
| ```bash | ||
| # Commands specified in CONTRIBUTING.md | ||
| ``` | ||
|
|
||
| 3. **Submit Changes** | ||
| - Fork the repository | ||
| - Create a feature branch | ||
| - Make your changes | ||
| - Submit a pull request | ||
|
|
||
| ## Project Architecture | ||
|
|
||
| The Up-For-Grabs website is built using: | ||
| - Jekyll for static site generation | ||
| - GitHub Pages for hosting | ||
| - GitHub Actions for continuous integration | ||
| - Netlify for preview deployments | ||
|
|
||
| Detailed technical documentation can be found in our [How it works](docs/how-it-works.md) guide. | ||
|
|
||
| ## Community Guidelines | ||
|
|
||
| - Be respectful and inclusive | ||
| - Help others learn and grow | ||
| - Follow the project's code of conduct | ||
| - Ask questions in our discussions section | ||
| - Report bugs through GitHub issues | ||
|
|
||
| ## Recognition | ||
|
|
||
| This project thrives thanks to our [contributors](#contributors). We follow the [all-contributors](https://github.com/all-contributors/all-contributors) specification and welcome contributions of any kind. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](LICENSE). | ||
|
|
||
| ## Support | ||
|
|
||
| - 📫 [Open an issue](https://github.com/up-for-grabs/up-for-grabs.net/issues) for bug reports or feature requests | ||
| - 💬 Join our discussions for general questions | ||
| - 🤝 Follow us on social media (links in website footer) | ||
|
|
||
| --- | ||
|
|
||
| *Up-For-Grabs - Making open source contribution accessible to everyone.* | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The fact that this change removes the CONTRIBUTORS section, which is auto-generated, makes this a non-starter for me.
If you want to write a better CONTRIBUTING guide in a new file, there is already a
.github/CONTRIBUTING.mdfile available that can be used as a starting point.There are also other docs under
docs/which could likely be improved.