From c5506f7ef92e42a414e1d7f79cce8f867e8bef2e Mon Sep 17 00:00:00 2001 From: Monalika Patnaik Date: Sat, 9 Dec 2023 20:01:11 +0530 Subject: [PATCH] Added contributing.md --- Contributing.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 00000000..9b8f585e --- /dev/null +++ b/Contributing.md @@ -0,0 +1,69 @@ + ### 🧑‍💻 Contribution Guidelines + +## Introduction + We deeply value your enthusiasm for enhancing this project! We warmly welcome your valuable contributions and invite you to participate in elevating it to new heights. + +## Getting Started +There are some steps that you need to follow before making any contribution in this project, the following steps are important to get start. + + +### Step 1. Fork the Repository + [Fork](https://github.com/MonalikaPatnaik/SheEARNS/fork) the repo first + +### Step 2. Clone the forked Repository + ``` + git clone https://github.com//SheEARNS.git + ``` +### Step 3. Set Up Remotes +- Add a reference (remote) to the original repository: + ``` + git remote add upstream https://github.com/MonalikaPatnaik/SheEARNS.git + ``` + - Add a reference (remote) to your forked repository: +``` +git remote add origin https://github.com//SheEARNS.git +``` + +### Step 4. Check Remotes +``` +git remote -v +``` + +### Step 5. Keep Your Local Copy Updated +``` +git pull upstream main +``` +### Step 6. Create a New Branch +``` +git checkout -b +``` + +## Making Changes +Perform your desired changes to the code base. +### Step 7. Track Changes + ``` + # Track the changes + git status + + # Add changes to Index + git add . or git add + ``` +### Step 8. Commit Changes + ``` + git commit -m "Write a meaningful but small commit message" + ``` + ### Step 9. Push Changes +``` +git push -u origin +``` +### 10. Compare and Create +- Click on "Compare And Pull Requests" 🔄 +- Make sure your pull request adheres to our contribution guidelines. Pull requests that do not meet the guidelines may be closed or discarded ❌ +- Add an appropriate title and description to your pull request, explaining your changes with suitable explanations and screenshots 📝🖼️ +- Click on "Create Pull Request" to submit your contribution for review ✅ + +We appreciate your understanding and cooperation in following our guidelines. Thank you for your contribution! 🙌 +Congratulations! You've made your PR with the desired changes. Once the PR is reviewed, it will be merged into the original codebase for everyone to see and use. + +## Thank You! +Thank you so much for contributing. We appreciate your valuable input, and we hope to see you again soon. 😊 \ No newline at end of file