docs: improve contributing guide (#1956)

* contributing: Updated the Readme * docs: improve contributing guide --------- Co-authored-by: Priyankar Pal <[email protected]>
priyankarpal · Aug 4, 2023 · 4259d6d · 4259d6d
1 parent 33e541b
commit 4259d6d
Showing 1 changed file with 19 additions and 10 deletions.
diff --git a/contributing.md b/contributing.md
@@ -59,50 +59,59 @@ git clone https://github.com/<YOUR-USERNAME>/ProjectsHut.git
 cd ProjectsHut
 ```
 
-3.  Install dependencies
+3. Add a reference(remote) to the original repository.
+```
+git remote add upstream https://github.com/priyankarpal/ProjectsHut.git
+```
+
+4. Check the remotes for this repository.
+```
+git remote -v
+```
+
+5.  Install dependencies
 
 ```bash
 pnpm i
 ```
 
 > **Note**: If you don't have pnpm installed in your system then run this command `npm i -g pnpm`
 
-4.  Now do ahead and create a new branch and move to the branch
+6.  Now do ahead and create a new branch and move to the branch
 
 ```bash
 git checkout -b fix-issue-<ISSUE-NUMBER>
 ```
 
 > **Note**: Replace `<ISSUE-NUMBER>` with the issue number you are working on
 
-5.  Run in local
+7.  Run in local
 
 ```bash
 pnpm dev
 ```
 
 > Add new features or fix bugs according to your issue number
 
-6.  After done you can now push this changes, for doing that follow the following command chain
+8.  After done you can now push this changes, for doing that follow the following command chain
 
 - `git status -s` (Shows the changed files)
 - `git add --all` (Will add all the files to staging area)
 - `git commit -m "feat/docs/fix: <EXPLAIN-YOUR_CHANGES>"`
 
   > **Note**: Replace `<EXPLAIN-YOUR_CHANGES>` with the changes you have made. Also, follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for writing commit messages
   
-- `git remote add upstream https://github.com/priyankarpal/ProjectsHut.git`
 - `git push origin fix-issue-<ISSUE-NUMBER>`
 
-7.  After this go to your forked GitHub repository and go to `Pull Request` section. Now you might be able to see a pop up saying **Pull Request**. Click on the popup and you will be redirected to pull request page
+9.  After this go to your forked GitHub repository and go to `Pull Request` section. Now you might be able to see a pop up saying **Pull Request**. Click on the popup and you will be redirected to pull request page
 
-8.  Now fill in the form template of the pull request and give the necessary description.
+10.  Now fill in the form template of the pull request and give the necessary description.
 
-9.  Click on **Submit**
+11.  Click on **Submit**
 
-10. Hurray! You just made your first contribution to this project 🎉
+12. Hurray! You just made your first contribution to this project 🎉
 
-11. Wait for your pull request to be reviewed and merged.
+13. Wait for your pull request to be reviewed and merged.
 
 ## Useful Links