Do you run or participate in an open-source project? Submit a Pull Request to add it to the list!
Visit the website: up-for-grabs.net
- Each of the projects is a file in the projects folder.
- To add a new one, create a new file named after the project, ending in
.yml
. - Ensure all spaces and special characters are replaced with
-
, to make everyone's life easier. - This guide shows you how to create the file directly in the browser, without cloning the repository in the command line.
The contents of the file are just some details about the project:
name: *project name*
desc: *a brief description of the project*
site: *home page or repository URL*
tags:
# Note: these are tags categorizing the project, not issue labels.
- *tags*
- *to*
- *search*
- *on*
upforgrabs:
name: *the label associated with the up-for-grabs tasks* -- e.g. "help needed" (without the quotes)
link: *URL where users can view the tasks* -- e.g. "https://github.com/username/project/labels/up%20for%20grabs"
Check out the up-for-grabs file for an example of this project structure.
We aim to be responsive when a pull request is open, but if a pull request remains idle for 2 weeks with feedback that prevents us from merging it we will close the pull request. You are welcome to resubmit the project and address the feedback provided.
If you'd like to use a generator to create the project's file, you can certainly do so!
Install the generator, then run it and walk through the steps.
npm install -g generator-up-for-grabs
yo up-for-grabs
If you would like to get involved with the project, please read the CONTRIBUTING.md file as it contains:
- instructions about getting your environment setup
- guidance for testing locally
- commands to run to verify changes
If you want to learn more about the various parts of the Up-for-Grabs project, the How it works document is a good overview.
Thanks goes to these wonderful people (emoji key):
Filipe Magalhaes Gomes 🖋 |
Manish Kumar Khedawat 💻 |
SpaceEEC 💻 |
João Manoel Lins 🖋 |
Crystal Yungwirth 🖋 |
Adis Talic 💻 |
Nathaniel Adams 💻 |
Ishan Sharma 💻 |
Firat Celik 💻 |
Paulo H. Costa 📖 |
XxZhang2017 🖋 💻 |
This project follows the all-contributors specification. Contributions of any kind are welcome!