Skip to content

Commit 6b74451

Browse files
docs: add about setting upstream (EddieHubCommunity#475)
* Add Set upstream command Set upstream command was missing in Contributing.md file. Successfully added set upstream command. * Update Fetch and merge * Update Github docs
1 parent 5c0a392 commit 6b74451

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

Contributing.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,40 @@
1919
git clone https://github.com/<your-github-username>/LinkFree
2020
```
2121

22-
**3.** Navigate to the new project directory:
22+
**3.** Set upstream command:
23+
```bash
24+
git remote add upstream https://github.com/EddieHubCommunity/LinkFree.git
25+
```
26+
27+
**4.** Navigate to the new project directory:
2328

2429
```bash
2530
cd LinkFree
2631
```
2732

28-
**4.** Create a new branch:
33+
**5.** Create a new branch:
2934
```bash
3035
git checkout -b YourBranchName
3136
```
3237

33-
**5.** Make your changes to the source code.
38+
**6.** Sync your fork or local repository with the origin repository:
39+
- In your forked repository click on "Fetch upstream"
40+
- Click "Fetch and merge".
41+
42+
43+
### Alternatively, Git CLI way to Sync forked repository with origin repository:
44+
```bash
45+
git fetch upstream
46+
```
47+
```bash
48+
git merge upstream/main
49+
```
50+
### [Github Docs](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github) for Syncing
51+
52+
53+
**7.** Make your changes to the source code.
3454

35-
**6.** Stage your changes and commit:
55+
**8.** Stage your changes and commit:
3656

3757
```bash
3858
git add .
@@ -42,15 +62,15 @@ git add .
4262
git commit -m "<your_commit_message>"
4363
```
4464

45-
**7.** Push your local commits to the remote repository:
65+
**9.** Push your local commits to the remote repository:
4666

4767
```bash
4868
git push origin YourBranchName
4969
```
5070

51-
**8.** Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)!
71+
**10.** Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)!
5272

53-
**9.** **Congratulations!** You've made your first contribution to [**LinkFree**](https://github.com/EddieHubCommunity/LinkFree/graphs/contributors)! 🙌🏼
73+
**11.** **Congratulations!** You've made your first contribution to [**LinkFree**](https://github.com/EddieHubCommunity/LinkFree/graphs/contributors)! 🙌🏼
5474

5575
***:trophy: After this, the maintainers will review the PR and will merge it if it helps move the LinkFree project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.***
5676

0 commit comments

Comments
 (0)