From 1085193c998ba54758c538f080168dbfd9f8ccec Mon Sep 17 00:00:00 2001 From: Abhishek Dumaniya Date: Thu, 16 May 2024 16:46:49 +0530 Subject: [PATCH] update CONTRIBUTING.md --- CONTRIBUTING.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cee5c73b..8c91e6aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # **Contributing Guidelines** 📄 This documentation contains a set of guidelines to help you during the contribution process. -We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. -Thank you for helping out and remember, **no contribution is too small.** +We are happy to welcome all the contributions from anyone willing to improve or add new scripts to this project. +Thank you for helping out, and remember, **no contribution is too small.**
Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in all your interactions with the project. @@ -13,13 +13,13 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in ## **Need some help regarding the basics?🤔** -You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, -in case you are stuck: +You can refer to the following articles on the basics of Git and Github and also contact the project mentors: +In case you are stuck: - [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) - [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) -- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) -- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) +- [How to Create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) +- [Getting Started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) - [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources)
@@ -27,20 +27,20 @@ in case you are stuck: ## **Issue Report Process 📌** 1. Go to the project's issues. -2. Give proper description for the issues. +2. Give a proper description of the issues. 3. Don't spam to get the assignment of the issue 😀. -4. Wait for till someone is looking into it !. -5. Start working on issue only after you got assigned that issue 🚀. +4. Wait until someone is looking into it! +5. Start working on the issue only after you get assigned that issue 🚀.
## **Pull Request Process 🚀** -1. Ensure that you have self reviewed your code 😀 -2. Make sure you have added the proper description for the functionality of the code -3. I have commented my code, particularly in hard-to-understand areas. -4. Add screenshot it help in review. -5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀 +1. Ensure that you have self-reviewed your code 😀 +2. Make sure you have added the proper description of the functionality of the code. +3. I have commented on my code, particularly in hard-to-understand areas. +4. Add a screenshot to help in the review. +5. Submit your PR by giving the necessary information in the PR template, and hang tight. We will review it soon 🚀