From 847613952e43b2a29bf5243a0706fc21e741e309 Mon Sep 17 00:00:00 2001 From: omsudhamsh Date: Sat, 15 Feb 2025 10:38:56 +0530 Subject: [PATCH] "Updated md File" --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 36 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b2a8ab5..13a36279 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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! \ No newline at end of file