-
Notifications
You must be signed in to change notification settings - Fork 647
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7f23b1b
commit fb404fe
Showing
1 changed file
with
13 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,34 +24,34 @@ To contribute a feature/fix: | |
Ready to contribute? Here's how to set up `Hub` for local development. | ||
|
||
1. Fork the `Hub` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
2. Clone your fork locally: | ||
``` | ||
$ git clone [email protected]:your_name_here/hub.git | ||
|
||
``` | ||
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, | ||
this is how you set up your fork for local development:: | ||
|
||
this is how you set up your fork for local development: | ||
``` | ||
$ mkvirtualenv Hub | ||
$ cd Hub/ | ||
|
||
4. Create a branch for local development:: | ||
|
||
``` | ||
4. Create a branch for local development: | ||
``` | ||
$ git checkout -b name-of-your-bugfix-or-feature | ||
|
||
``` | ||
Now you can make your changes locally. | ||
|
||
5. While hacking your changes, make sure to cover all your developments with the required | ||
unit tests, and that none of the old tests fail as a consequence of your changes. | ||
For this, make sure to run the tests suite and check the code coverage:: | ||
|
||
``` | ||
$ pytest . # Run the tests | ||
|
||
``` | ||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
``` | ||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ git push origin name-of-your-bugfix-or-feature | ||
|
||
``` | ||
7. Submit a pull request through the GitHub website. | ||
|
||
|
||
|