From 56a62dc8d2e12ee90ff5e8d022b5a69c1dc7ecfd Mon Sep 17 00:00:00 2001 From: anatoly techtonik Date: Sun, 27 Oct 2013 19:52:56 +0300 Subject: [PATCH] docs: Expand development section example for #1259 --- docs/development.rst | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index 9146c8c8b..0e181b130 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -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 ... $ 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