Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

"Updated md File" #1572

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 36 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,38 @@
# Contribution Guidelines

Please ensure that your pull request adheres to the following guidelines:

- Search previous suggestions before making a new one to avoid duplicates.
- Ensure your contribution is useful and relevant, with sufficient content and a clear, concise description for each item. Make sure your contribution is useful and relevant before submitting. That implies it has enough content and every item has a good succinct description.
- Make an individual pull request for each suggestion.
- Only include your suggested repository to `data.json` file, README.md file is generated from it.
- New categories or improvements to existing categories are welcome.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request and commit should be given a meaningful title.
- Ensure that you describe your pull request.
- If the label does not clearly state its "beginner-friendly" purpose, confirm with the maintainer that it is used for such issues. Include a link to where the maintainer approves this.
- Maintainer confirmation is also required in case repository has more than one beginner-friendly-like label (e.g. `low-hanging-fruit` and `up-for-grabs`).
- Ensure the contributed repository is actively maintained, has a supportive community, and issues with appropriate labels.
- Links must be pointing directly to the repository, no tracking links allowed. This list is not for advertising purposes.

Thank you for your suggestions!!
Thank you for your interest in contributing! Please ensure that your pull request adheres to the following guidelines:

## Before You Start

- **Search for Duplicates**: Check previous suggestions to avoid submitting duplicates.
- **Relevance and Quality**: Ensure your contribution is useful and relevant. It should contain sufficient content and a clear, concise description for each item.

## Making a Contribution

- **Individual Pull Requests**: Submit a separate pull request for each suggestion.
- **File Modifications**: Add your suggested repository only to the `data.json` file. The `README.md` file is generated from it.
- **Categories**: Feel free to suggest new categories or improvements to existing ones.

## Code Quality

- **Spelling and Grammar**: Proofread your contribution for spelling and grammar errors.
- **Trailing Whitespace**: Ensure your text editor is set to remove trailing whitespace.

## Pull Request Details

- **Meaningful Titles**: Give your pull request and commit a meaningful title.
- **Description**: Provide a clear description of your pull request.

## Labels and Maintainer Approval

- **Beginner-Friendly Labels**: If the label does not clearly state its "beginner-friendly" purpose, confirm with the maintainer that it is used for such issues. Include a link to where the maintainer approves this.
- **Multiple Labels**: If the repository has more than one beginner-friendly-like label (e.g., `low-hanging-fruit` and `up-for-grabs`), obtain maintainer confirmation.

## Repository Requirements

- **Active Maintenance**: Ensure the contributed repository is actively maintained.
- **Supportive Community**: The repository should have a supportive community.
- **Appropriate Labels**: Issues should have appropriate labels.
- **Direct Links**: Links must point directly to the repository. No tracking links are allowed. This list is not for advertising purposes.

Thank you for your suggestions!