mirror of
https://github.com/pypa/pip
synced 2023-12-13 21:30:23 +01:00
docs: Expand development section example for #1259
This commit is contained in:
parent
78c299aee7
commit
56a62dc8d2
|
@ -5,14 +5,11 @@ Development
|
|||
Pull Requests
|
||||
=============
|
||||
|
||||
Submit Pull Requests against the `develop` branch.
|
||||
- Submit Pull Requests against the `develop` branch.
|
||||
- Provide a good description of what you're doing and why.
|
||||
- Provide tests that cover your changes and try to run the tests locally first.
|
||||
|
||||
Provide a good description of what you're doing and why.
|
||||
|
||||
Provide tests that cover your changes and try to run the tests locally first.
|
||||
|
||||
|
||||
Example. Assuming you set up GitHub account, forked pip repository from
|
||||
**Example**. Assuming you set up GitHub account, forked pip repository from
|
||||
https://github.com/pypa/pip to your own page via web interface, and your
|
||||
fork is located at https://github.com/yourname/pip
|
||||
|
||||
|
@ -20,17 +17,21 @@ fork is located at https://github.com/yourname/pip
|
|||
|
||||
$ git clone git@github.com:pypa/pip.git
|
||||
$ cd pip
|
||||
|
||||
# ...
|
||||
|
||||
$ gid diff
|
||||
$ git diff
|
||||
$ git add <modified> ...
|
||||
$ git status
|
||||
$ git commit
|
||||
|
||||
You may reference relevant issue with #1259 syntax in commit messages to
|
||||
allow GitHub to link issue and commit number together, with words like
|
||||
"fixes #1259" you can even make it close relevant issues automatically.
|
||||
You may reference relevant issues in commit messages (like #1259) to
|
||||
make GitHub link issues and commits together, and with phrase like
|
||||
"fixes #1259" you can even close relevant issues automatically. Now
|
||||
push the changes to your fork::
|
||||
|
||||
$ git push git@github.com:yourname/pip.git
|
||||
|
||||
Open Pull Requests page at https://github.com/yourname/pip/pulls and
|
||||
click "New pull request". That's it.
|
||||
|
||||
|
||||
Automated Testing
|
||||
|
|
Loading…
Reference in a new issue