Skip to content

Commit b692069

Browse files
authored
Update CONTRIBUTING.md with forking instructions
Fixes #225
1 parent 2961d77 commit b692069

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

CONTRIBUTING.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,24 @@ Send an email to the Modular Documentation Project mailing list (ccs-mod-docs@re
66

77
## Configuring a Local Copy of the GitHub Project
88

9-
STEP 1 - Clone the GitHub project locally:
9+
STEP 1 - Fork your own copy of redhat-documentation/modular-docs:
10+
![image](https://github.com/redhat-documentation/modular-docs/assets/350907/e27b585e-f7f8-4b29-a62a-a0dbd025cebc)
1011

11-
git clone [email protected]:redhat-documentation/modular-docs.git
12+
STEP 2 - Go to your fork and copy the SSH link.
13+
![image](https://github.com/redhat-documentation/modular-docs/assets/350907/829fb743-104a-4db1-848e-8a7cd4994376)
1214

13-
STEP 2 - Verify the GitHub project status:
15+
STEP 3 - In a terminal, clone your fork:
16+
17+
git clone [email protected]:_<username>_/modular-docs.git
18+
19+
STEP 4 - Copy the SSH link of redhat-documentation/modular-docs, not your fork, and set it as your upstream remote:
1420

1521
cd modular-docs
22+
git remote add upstream [email protected]:redhat-documentation/modular-docs.git
23+
24+
STEP 5 - Verify that you have two remotes, `origin` and `upstream` and check the status of your project:
25+
26+
git remote -v
1627
git status
1728

1829
## Contributing Changes

0 commit comments

Comments
 (0)