Welcome to the Awesome First Pull Request Opportunities project! We're excited that you want to contribute.
This guide aims to help you get started contributing new repositories to the list.
It outlines the recommended order for executing tasks and assumes that you have identified a repository you wish to add to the list. Check out the repository requirements section, if you would like to know what a good addition should have.
Please note that the list in this repository is intended for more substantial projects, and we kindly ask that small personal projects not be added in the hope of receiving contributions. Thank you for your understanding.
- Search for Duplicates: Check the current list and previous pull requests to avoid submitting duplicates.
- Reasonably Developed: The repository must be reasonably established, along with having with a clear goal or function. New repositories with few commits and little content will likely be rejected.
- Active Maintenance: Ensure the contributed repository is actively maintained.
- Appropriate Labels: Issues with appropriate beginner-friend labels must exist. Confirm with the owner around a label's meaning if it's not obviously beginner-friendly (usually
good-first-issue
orlow-hanging-fruit
). - Supportive Community: The repository should have a supportive community.
The easiest way to contribute is by editing the data.json
file directly in your browser. Here's how:
- Go to the
data.json
file in the repository. - Click the "Edit" button (pencil icon) in the top right corner.
- Make your changes directly in the browser:
- Copy an existing entry in the file.
- Fill in your own information following the same format.
- Ensure to check the following:
- Direct Links: Links must point directly to the repository. No tracking links are allowed. This list is not for advertising purposes.
- Spelling and Grammar: Proofread your contribution for spelling and grammar errors.
- Trailing Whitespace: Ensure to avoiding adding any trailing whitespace (at the end of lines).
- Spelling and Grammar: Proofread your contribution for spelling and grammar errors.
- Single addition: Make an individual pull request for each suggestion.
- New Technologies: New technologies are welcomed, all you need to do is add them and a new heading will be generated for them.
- Describe your changes concisely in the commit message.
- Click "Propose changes" to create a new branch and open a Pull Request (PR).
- After proposing changes, GitHub will guide you through creating a PR.
- Fill out the PR form, ensuring its content (especially the title) is understandable, descriptive and relevant.
- If your suggest repository uses a non-obvious beginner-friendly issue label, ensure to link to confirmation or proof that the label is beginner friendly.
- Submit the PR and wait for feedback from the maintainers.
If you encounter an issue or have a suggestion that you don't want to implement yourself, open an issue ensuring you provide:
- A clear description of the problem or suggestion.
- The expected behavior (if creating a feature request or bug report).
- The current behavior (if creating a bug report).
For a more comprehensive guide on contributing to open-source projects, check out the First Contributions repository.
Thank you for your contribution!