Skip to content

Commit e3ffca7

Browse files
committed
updating readme from first contributions repository as exampleRead me update taking first contributions readme as an example
1 parent 51d986e commit e3ffca7

File tree

1 file changed

+165
-1
lines changed

1 file changed

+165
-1
lines changed

README.md

Lines changed: 165 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,173 @@ You can find the most recent version of this guide [here](https://github.com/fac
1717
</a>
1818
</p>
1919

20+
[**How to run this project**](HOW_TO_RUN.md)
2021

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).*
29+
30+
[:bangladesh:](translations/README.bn.md)
31+
[🇧🇬](translations/README.bg.md)
32+
[🇧🇷](translations/README.pt_br.md)
33+
[<img src="assets/catalan1.png" width="22">](translations/README.ca.md)
34+
[🇨🇳](translations/README.chs.md)
35+
[🇨🇿](translations/README.cs.md)
36+
[🇩🇪](translations/README.de.md)
37+
[🇩🇰](translations/README.da.md)
38+
[🇪🇬](translations/README.eg.md)
39+
[🇪🇸](translations/README.es.md)
40+
[🇫🇷](translations/README.fr.md)
41+
[🏴](translations/README.gl.md)
42+
[🇬🇷](translations/README.gr.md)
43+
[🇭🇺](translations/README.hu.md)
44+
[🇮🇩](translations/README.id.md)
45+
[🇮🇱](translations/README.hb.md)
46+
[🇮🇳](translations/Translations.md)
47+
[🇮🇷](translations/README.fa.md)
48+
[🇮🇷](translations/README.fa.en.md)
49+
[🇮🇹](translations/README.it.md)
50+
[🇯🇵](translations/README.ja.md)
51+
[🇰🇪](translations/README.kws.md)
52+
[🇰🇷 🇰🇵](translations/README.ko.md)
53+
[🇱🇹](translations/README.lt.md)
54+
[🇲🇩 🇷🇴](translations/README.ro.md)
55+
[🇲🇲](translations/README.mm_unicode.md)
56+
[🇲🇰](translations/README.mk.md)
57+
[🇲🇽](translations/README.mx.md)
58+
[🇲🇾](translations/README.my.md)
59+
[🇳🇱](translations/README.nl.md)
60+
[🇳🇬](translations/README.igb.md)
61+
[🇳🇴](translations/README.no.md)
62+
[🇳🇵](translations/README.np.md)
63+
[🇵🇭](translations/README.tl.md)
64+
[<img src="assets/pirate.png" width="22">](translations/README.en-pirate.md)
65+
[🇵🇰](translations/README.ur.md)
66+
[🇵🇱](translations/README.pl.md)
67+
[🇵🇹](translations/README.pt-pt.md)
68+
[🇷🇺](translations/README.ru.md)
69+
[🇸🇦](translations/README.ar.md)
70+
[🇸🇪](translations/README.se.md)
71+
[:slovakia:](translations/README.slk.md)
72+
[:slovenia:](translations/README.sl.md)
73+
[🇹🇭](translations/README.th.md)
74+
[🇹🇷](translations/README.tr.md)
75+
[🇹🇼](translations/README.cht.md)
76+
[🇺🇦](translations/README.ua.md)
77+
[🇻🇳](translations/README.vn.md)
78+
[🇿🇦](translations/README.zul.md)
79+
[🇿🇦](translations/README.afk.md)
80+
[🇰🇪](translations/README.kws.md)
81+
[🇳🇬](translations/README.igb.md)
82+
[🇱🇻](translations/README.lv.md)
83+
[🇫🇮](translations/README.fi.md)
84+
85+
86+
87+
<img align="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+
<img align="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+
<img align="right" width="300" src="https://github.com/firstcontributions/first-contributions/blob/master/assets/copy-to-clipboard.png?raw=true" alt="copy URL to clipboard" />
110+
111+
For example:
112+
```
113+
git clone https://github.com/this-is-you/first-contributions.git
114+
```
115+
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.
138+
139+
<img align="right" width="450" src="https://github.com/firstcontributions/first-contributions/blob/master/assets/git-status.png?raw=true" alt="git status" />
140+
141+
142+
If you go to the project directory and execute the command `git status`, you'll see there are changes.
143+
144+
145+
Add those changes to the branch you just created using the `git add` command:
146+
147+
```
148+
git add Contributors.md
149+
```
150+
151+
Now commit those changes using the `git commit` command:
152+
```
153+
git commit -m "Add <your-name> to Contributors list"
154+
```
155+
replacing `<your-name>` with your name.
156+
157+
## Push changes to GitHub
158+
159+
Push your changes using the command `git push`:
160+
```
161+
git push origin <add-your-branch-name>
162+
```
163+
replacing `<add-your-branch-name>` with the name of the branch you created earlier.
164+
165+
## Submit your changes for review
166+
167+
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
168+
169+
<img style="float: right;" src="https://github.com/firstcontributions/first-contributions/blob/master/assets/compare-and-pull.png?raw=true" alt="create a pull request" />
170+
171+
Now submit the pull request.
172+
173+
<img style="float: right;" src="https://github.com/firstcontributions/first-contributions/blob/master/assets/submit-pull-request.png?raw=true" alt="submit pull request" />
174+
175+
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).
21186

22-
[How to run this project](HOW_TO_RUN.md)
23187

24188
## Tutorials Using Other Tools
25189

0 commit comments

Comments
 (0)