Skip to content

Commit

Permalink
add instructions to the README and gifs
Browse files Browse the repository at this point in the history
  • Loading branch information
ascott1 committed Jun 11, 2015
1 parent e7a4e3a commit 576ade7
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# fork-me
Practice forking a repo and making a pull request
> Practice forking a repo and making a pull request
## Instructions

1. Fork this repo by clicking the fork button at the top of the screen
2. Clone your fork of the repo to your local machine

```bash
# in the terminal, use what you copy and pasted
git clone git@github.com:YOURGITHUBUSERNAME/fork-me.git
```

3. Add a file in the /contributors/ directory named either `you_name.md` or `your_name.txt` and add something about yourself.

```
steve_zissou.md
I am an oceanographer, documentarian, and newfound father aboard the ship Belafonte. I am currently at work filming a documentary about the elusive Jaguar Shark. My other intersts include jump suits, track sneakers, and knit caps.
```

4. Commit your changes and push them to GitHub.

```bash
git add .
git commit -m "adding my name to the contributors"
git push
```

5. Now, back to GitHub.com, visit your fork of the repo (https://github.com/YOURUSERSNAME/fork-me), click the "Pull Request" button.

6. Click the "Create Pull Request" button.


7. Add a title to your pull request and a brief description of the change and click the "Create Pull Request" button.

That's it! Your changes are now waiting to be added to the codebase.
Binary file added img/clone_link.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/create_pull_request.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/fork_click.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/make_pull_request.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/pull_request_click.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 576ade7

Please sign in to comment.