Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Commit 2503979

Browse files
authored
Merge pull request #125 from KarenEfereyan/updateDocs
Updated documentation
2 parents 454b295 + b565371 commit 2503979

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,38 @@ Questions can be asked by raising an `Issue`.
2121
## How to clone repo and make changes locally
2222

2323
```
24-
click on the clone button (green in colour).
24+
click on the clone button (green in colour). This gives you a copy of the project. Its now yours to play around with
2525
```
2626

27-
- Using git on your local machine
27+
- Using git on your local machine. Do this to download the forked copy of this repo to your computer
2828

2929
```
30-
git clone https://github.com/eddiejaoude/hacktoberfest-practice.git
30+
git clone https://github.com/yourGithubUsername/hacktoberfest-practice.git
3131
```
3232

33-
- switch to the cloned folder
33+
- switch to the cloned folder. This can be done with Gitbash or the integrated terminal in the VSCode editor
3434

3535
```
3636
cd hacktoberfest-practice
3737
```
3838

39-
- Make a new branch
39+
- Make a new branch. Your name would make a good branch because it's unique
4040

4141
```
4242
git checkout -b <name of new branch>
4343
```
4444

45-
- Make changes in your repo
45+
- Open the file `README.md`
46+
47+
- On a new line in alphabetical order, add your name and a link to your Github profile
48+
49+
- For example ,
50+
`[Full Name](https://github.com/your-username)`
51+
52+
- Stage your changes
4653

4754
```
48-
touch text.txt
49-
echo "Hallo world" > text.txt
50-
git add text.txt
55+
git add README.md
5156
```
5257

5358
- Commit the changes
@@ -56,7 +61,7 @@ Questions can be asked by raising an `Issue`.
5661
git commit -m "Initial commit"
5762
```
5863

59-
- Check the staus of your repository
64+
- Check the status of your repository
6065

6166
```
6267
git status
@@ -68,12 +73,17 @@ Questions can be asked by raising an `Issue`.
6873
git push origin <name of your branch>
6974
```
7075

71-
- Pulling your request
76+
- Pulling your request. Click on the Pull requests tab on the forked github repository.
77+
Note : A pull request allows your changes to be merged with the original project.
7278

7379
```
7480
click on pull request
7581
```
7682

83+
- Wait for your changes to be merged.
84+
85+
- Hurray! You successfully made a contribution
86+
7787
## Hacktoberfest community
7888

7989
- [Aakarsh Teja](https://github.com/aakarshteja)

0 commit comments

Comments
 (0)