From 8fe559ae7dac434cebc5b35d20ac478174b1eb35 Mon Sep 17 00:00:00 2001 From: Abdullah Al Zawad Date: Fri, 25 Oct 2024 16:48:31 +0600 Subject: [PATCH] A better read me and made it easier to contribute to the read me The project has great potential but the read me is not that good the improvement includes the proper structure and separation into clear sections, quick links for easier navigation, different guides for project maintainers and contributors, setup and contribution instructions in detail, architecture description, community guidelines and support sections, improved formatting and readability, various emojis to help make it more visually interesting and scannable, and clear step-by-step instructions on how to perform common tasks. Best regards, - Zawad (Hoping for the best) --- README.md | 166 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 95 insertions(+), 71 deletions(-) diff --git a/README.md b/README.md index 12b4d359542..68d8bc0f968 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,97 @@ -[up-for-grabs.net](https://up-for-grabs.net/) -![Continuous Integration status](https://github.com/up-for-grabs/up-for-grabs.net/workflows/Continuous%20Integration/badge.svg) +# Up-For-Grabs + +[![Continuous Integration status](https://github.com/up-for-grabs/up-for-grabs.net/workflows/Continuous%20Integration/badge.svg)](https://github.com/up-for-grabs/up-for-grabs.net/actions) [![Netlify Status](https://api.netlify.com/api/v1/badges/0ee7bf9f-1aed-465b-8e9e-01de009a8a7e/deploy-status)](https://app.netlify.com/sites/up-for-grabs-test-bench/deploys) [![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors) -================ - - - -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)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Filipe Magalhaes Gomes
Filipe Magalhaes Gomes
🖋		Manish Kumar Khedawat
Manish Kumar Khedawat
💻		SpaceEEC
SpaceEEC
💻		João Manoel Lins
João Manoel Lins
🖋		Crystal Yungwirth
Crystal Yungwirth
🖋		Adis Talic
Adis Talic
💻		Nathaniel Adams
Nathaniel Adams
💻
Ishan Sharma
Ishan Sharma
💻		Firat Celik
Firat Celik
💻		Paulo H. Costa
Paulo H. Costa
📖		XxZhang2017
XxZhang2017
🖋 💻		Chad Whitacre
Chad Whitacre
📖		Jai
Jai
💻		James Alaniz
James Alaniz
💻
Genevieve Warren
Genevieve Warren
📖		Saad
Saad
💻		Jeet Patel
Jeet Patel
💻
- - - - - - -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.*