You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+165-1Lines changed: 165 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,173 @@ You can find the most recent version of this guide [here](https://github.com/fac
17
17
</a>
18
18
</p>
19
19
20
+
[**How to run this project**](HOW_TO_RUN.md)
20
21
22
+
It's hard. It's always hard the first time you do something. Especially when you are collaborating, making mistakes isn't a comfortable thing. We wanted to simplify the way new open-source contributors learn & contribute for the first time.
23
+
24
+
Reading articles & watching tutorials can help, but what's better than actually doing the stuff in a practice environment? This project aims at providing guidance & simplifying the way beginners make their first contribution. If you are looking to make your first contribution, follow the steps below.
25
+
26
+
#### *If you're not comfortable with command line, [here are tutorials using GUI tools.](#tutorials-using-other-tools)*
27
+
28
+
#### *Read this in [other languages](translations/Translations.md).*
<imgalign="right"width="300"src="https://github.com/firstcontributions/first-contributions/blob/master/assets/fork.png?raw=true"alt="fork this repository" />
88
+
89
+
If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/).
90
+
91
+
## Fork this repository
92
+
93
+
Fork this repository by clicking on the fork button on the top of this page.
94
+
This will create a copy of this repository in your account.
95
+
96
+
## Clone the repository
97
+
98
+
<imgalign="right"width="300"src="https://github.com/firstcontributions/first-contributions/blob/master/assets/clone.png?raw=true"alt="clone this repository" />
99
+
100
+
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the clone button and then click the *copy to clipboard* icon.
101
+
102
+
Open a terminal and run the following git command:
103
+
104
+
```
105
+
git clone "url you just copied"
106
+
```
107
+
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.
108
+
109
+
<imgalign="right"width="300"src="https://github.com/firstcontributions/first-contributions/blob/master/assets/copy-to-clipboard.png?raw=true"alt="copy URL to clipboard" />
where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.
116
+
117
+
## Create a branch
118
+
119
+
Change to the repository directory on your computer (if you are not already there):
120
+
121
+
```
122
+
cd first-contributions
123
+
```
124
+
Now create a branch using the `git checkout` command:
125
+
```
126
+
git checkout -b <add-your-new-branch-name>
127
+
```
128
+
129
+
For example:
130
+
```
131
+
git checkout -b add-alonzo-church
132
+
```
133
+
(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.)
134
+
135
+
## Make necessary changes and commit those changes
136
+
137
+
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.
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.
176
+
177
+
## Where to go from here?
178
+
179
+
Congrats! You just completed the standard _fork -> clone -> edit -> PR_ workflow that you'll encounter often as a contributor!
180
+
181
+
Celebrate your contribution and share it with your friends and followers by going to [web app](https://firstcontributions.github.io/#social-share).
182
+
183
+
You could join our slack team in case you need any help or have any questions. [Join slack team](https://join.slack.com/t/firstcontributors/shared_invite/enQtNjkxNzQwNzA2MTMwLTVhMWJjNjg2ODRlNWZhNjIzYjgwNDIyZWYwZjhjYTQ4OTBjMWM0MmFhZDUxNzBiYzczMGNiYzcxNjkzZDZlMDM).
184
+
185
+
Now let's get you started with contributing to other projects. We've compiled a list of projects with easy issues you can get started on. Check out [the list of projects in the web app](https://firstcontributions.github.io/#project-list).
0 commit comments