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

Commit 8f5fcf9

Browse files
author
Efereyan Karen Simisola
committed
Updated documentation
1 parent f9abd37 commit 8f5fcf9

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

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

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

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

2727
```
28-
git clone https://github.com/eddiejaoude/hacktoberfest-practice.git
28+
git clone https://github.com/yourGithubUsername/hacktoberfest-practice.git
2929
```
3030

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

3333
```
3434
cd hacktoberfest-practice
3535
```
3636

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

3939
```
4040
git checkout -b <name of new branch>
4141
```
4242

43-
- Make changes in your repo
43+
- Make changes in your repo by opening the README.md file and adding your full name along with a link to your github profile
4444

4545
```
46-
touch text.txt
47-
echo "Hallo world" > text.txt
48-
git add text.txt
46+
open ReadMe. md
47+
On a new line type in ..
48+
Full Name [github.com/githubUsername]
49+
```
50+
- Stage your changes
51+
52+
```
53+
git add README.md
4954
```
5055

5156
- Commit the changes
@@ -54,7 +59,7 @@ Questions can be asked by raising an `Issue`.
5459
git commit -m "Initial commit"
5560
```
5661

57-
- Check the staus of your repository
62+
- Check the status of your repository
5863

5964
```
6065
git status
@@ -66,12 +71,18 @@ Questions can be asked by raising an `Issue`.
6671
git push origin <name of your branch>
6772
```
6873

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

7178
```
7279
click on pull request
7380
```
7481

82+
- Wait for your changes to be merged.
83+
84+
- Hurray! You successfully made a contribution
85+
7586
## Hacktoberfest community
7687

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

0 commit comments

Comments
 (0)