Skip to content

Commit

Permalink
Added ajborka to contributers.md and reformatted readme.md for easier…
Browse files Browse the repository at this point in the history
… reading.
  • Loading branch information
ajborka committed Dec 28, 2016
1 parent 9768580 commit 8d2e1db
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 98 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
Expand Down
2 changes: 2 additions & 0 deletions Contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@
- [Jon Johnson] (https://github.com/jonjohnson34)
- [Brandon Brigance] (https://github.com/b-random)
- [Jaspreet Singh] (https://github.com/singh19196)

- [ajborka](https://www.github.com/ajborka)
121 changes: 24 additions & 97 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,100 +2,27 @@

*Read this in other languages: [English](README.md), [Spanish](README.es.md)*

If you don't have git on your machine, [ install it ]( https://help.github.com/articles/set-up-git/ )

Fork this repo by clicking on the fork button

<img style="float: right;" width="300" src="assets/fork.png">

Now clone this repo to your machine. Click on clone button and then copy to clipboard icon

<img style="float: right;" width="300" src="assets/clone.png">
<img style="float: right;" width="300" src="assets/copy-to-clipboard.png">

Open a terminal and run

```
git clone <url you just copied>
```
Where the url can be pasted from clipboard
For example
```
git clone https://github.com/this-is-you/first-contributions.git
```
Here you're copying the contents of first-contributions repository in github to your computer

Go in to that directory

```
cd first-contributions
```

Now create a branch using `git checkout command`

```
git checkout -b <add-your-name>
```
For example
```
git checkout -b add-alonzo-church
```

Now open `Contributors.md` file in a text editor and add your name to it, save the file

If you go to the project directory and do `git status`, you'll see there are changes

Add those change using `git add`

```
git add Contributors.md
```

Now commit those changes using `git commit`

```
git commit -m "Add <your-name> to Contributors list"
```
replace `<your-name>` with your name

Push your changes using `git push`

```
git push origin <add-your-name>
```
Replace `<add-your-name>` with the name of the branch you created earlier

If you go to your repo on github, you'll see a button to open a pull request. click on that button

<img style="float: right;" src="assets/compare-and-pull.png">

Now submit the pull request

<img style="float: right;" src="assets/submit-pull.png">

### Keeping your fork synced with this repo

Now I'll be merging all your changes in to master branch of this project.
Then your fork won't have those changes. In order to keep your fork synced with mine,

Add my repo's url as `upstream remote url`

```
git remote add upstream https://github.com/Roshanjossey/first-contributions
```
This is a way of telling git that another version of this project exists in the specified url and we're calling it master.

```
git fetch upstream
```
Here we're fetching all the changes in my fork (upstream remote)

```
git rebase upstream/master
```
Here you're applying all the changes you fetched to master branch.
If you push master branch now, your fork will also have the changes
```
git push origin master
```
Notice here you're pushing to the remote named origin
<h2>Instructions for contributing to this repository</h2><br />

1. If you don't have git on your machine, [ install it ]( https://help.github.com/articles/set-up-git/).
2. Fork this repository by clicking on the fork button: <img style="float: right;" width="300" src="assets/fork.png" alt="Fork this repo." />
3. Now clone this repo to your machine. Click on the clone button and then click the copy to clipboard icon:&nbsp;<img style="float: right;" width="300" src="assets/clone.png" alt = "Clone this repo." />&nbsp;<img style="float: right;" width="300" src="assets/copy-to-clipboard.png" alt="Copy to clipboard." />
4. In a terminal, type the following command followed by the ENTER key: git clone https://github.com/this-is-you/first-contributions.git, where 'this-is-you' is your github username. Here you're copying the contents of first-contributions repository in github to your computer.
5. Go in to that directory by typing the following command followed by the ENTER key: cd first-contributions.
6. Now create a branch using git checkout -b <add-your-name>.
7. Now open `Contributors.md` file in a text editor and add your name to it, save the file.

If you go to the project directory and do `git status`, you'll see there are changes.

8. Add those changes using `git add`: git add *
9. Now commit those changes using `git commit`: git commit -m "Add <your-name> to Contributors list", where `<your-name>` is your name
10. Push your changes using `git push`: git push origin <add-your-name>, where `<add-your-name>` is the name of the branch you created earlier.
11. Ggo to your repo on github, you'll see a button to open a pull request. click on that button:&nbsp;<img style="float: right;" src="assets/compare-and-pull.png">
12. Submit the pull request:&nbsp;<img style="float: right;" src="assets/submit-pull.png">
<h2> Keeping your fork synced with this repo</h2>

Now I'll be merging all your changes in to master branch of this project. Then your fork won't have those changes. In order to keep your fork synced with mine, add my repo's url as `upstream remote url`.
13. git remote add upstream https://github.com/Roshanjossey/first-contributions. This is a way of telling git that another version of this project exists in the specified url and we're calling it master.
14. git fetch upstream. Here we're fetching all the changes in my fork (upstream remote).
15. git rebase upstream/master. Here you're applying all the changes you fetched to master branch.
16. Push master branch now, your fork will also have the changes: git push origin master. Notice here you're pushing to the remote named origin

0 comments on commit 8d2e1db

Please sign in to comment.