Updated pull request section of contributing guidelines.

This commit is contained in:
Donne Martin 2015-07-15 05:13:32 -04:00
parent 81457247fd
commit 502c4d77e4

View File

@ -3,7 +3,7 @@ Contributing
Contributions are welcome!
Please carefully read this page before submitting a pull request.
**Please carefully read this page to make the code review process go as smoothly as possible and to maximize the likelihood of your contribution being merged.**
## Bug Reports
@ -13,6 +13,33 @@ For bug reports or requests [submit an issue](https://github.com/donnemartin/int
**Please follow the general [Repo Structure](https://github.com/donnemartin/interactive-coding-challenges#repo-structure) and [Notebook Structure](https://github.com/donnemartin/interactive-coding-challenges#notebook-structure) before submitting your pull request.**
The preferred way to contribute is to fork the
[main repository](https://github.com/donnemartin/interactive-coding-challenges) on GitHub.
1. Fork the [main repository](https://github.com/donnemartin/interactive-coding-challenges). Click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.
2. Clone this copy to your local disk:
$ git clone git@github.com:YourLogin/interactive-coding-challenges.git
$ cd interactive-coding-challenges
3. Create a branch to hold your changes and start making changes. Don't work in the ``master`` branch!
$ git checkout -b my-feature
4. Work on this copy on your computer using Git to do the version control. When you're done editing, run the following to record your changes in Git:
$ git add modified_files
$ git commit
5. Push your changes to GitHub with:
$ git push -u origin my-feature
6. Finally, go to the web page of your fork of the interactive-coding-challenges repo and click 'Pull request' to send your changes for review.
**Please submit one pull request per challenge.**
### GitHub Pull Requests Docs
If you are not familiar with pull requests, review the [pull request docs](https://help.github.com/articles/using-pull-requests/).