Skip to content

Commit 438baf2

Browse files
committed
➕ added contributors.md file
1 parent c96814a commit 438baf2

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed

contributors.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
#### If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/)
2+
3+
## Fork this repository
4+
5+
Fork this repository by clicking on the fork button on the top of this page.
6+
This will create a copy of this repository in your account.
7+
8+
## Clone the repository
9+
10+
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/clone.png" alt="clone this repository" />
11+
12+
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.
13+
14+
Open a terminal and run the following git command:
15+
16+
```
17+
git clone "url you just copied"
18+
```
19+
20+
where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
21+
22+
<img align="right" width="300" src="https://firstcontributions.github.io/assets/Readme/copy-to-clipboard.png" alt="copy URL to clipboard" />
23+
24+
For example:
25+
26+
```
27+
git clone https://github.com/this-is-you/first-contributions.git
28+
```
29+
30+
where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.
31+
32+
## Create a branch
33+
34+
Change to the repository directory on your computer (if you are not already there):
35+
36+
```
37+
cd first-contributions
38+
```
39+
40+
Now create a branch using the `git checkout` command:
41+
42+
```
43+
git checkout -b your-new-branch-name
44+
```
45+
46+
For example:
47+
48+
```
49+
git checkout -b add-alonzo-church
50+
```
51+
52+
(The name of the branch does not need to have the word _add_ in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.)
53+
54+
## Make necessary changes and commit those changes
55+
56+
Now open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.
57+
58+
<img align="right" width="450" src="assets/git-status.png" alt="git status" />
59+
60+
If you go to the project directory and execute the command `git status`, you'll see there are changes.
61+
62+
Add those changes to the branch you just created using the `git add` command:
63+
64+
```
65+
git add Contributors.md
66+
```
67+
68+
Now commit those changes using the `git commit` command:
69+
70+
```
71+
git commit -m "Add <your-name> to Contributors list"
72+
```
73+
74+
replacing `<your-name>` with your name.
75+
76+
## Push changes to GitHub
77+
78+
Push your changes using the command `git push`:
79+
80+
```
81+
git push origin <add-your-branch-name>
82+
```
83+
84+
replacing `<add-your-branch-name>` with the name of the branch you created earlier.
85+
86+
## Submit your changes for review
87+
88+
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
89+
90+
<img style="float: right;" src="assets/compare-and-pull.png" alt="create a pull request" />
91+
92+
Now submit the pull request.
93+
94+
<img style="float: right;" src="assets/submit-pull-request.png" alt="submit pull request" />
95+
96+
Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.
97+
98+
## Where to go from here?
99+
100+
Congrats! You just completed the standard _fork -> clone -> edit -> pull request_ workflow that you'll encounter often as a contributor!

0 commit comments

Comments
 (0)