From c2b4b745e946aece1bf253a29e6a1161ae14347d Mon Sep 17 00:00:00 2001 From: Abhinav Date: Tue, 23 Apr 2019 23:23:24 +0530 Subject: [PATCH 1/2] add more git commands to contributing doc --- CONTRIBUTING.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 44bb53d5..0fdc18b1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -82,14 +82,27 @@ First time setup Start coding ~~~~~~~~~~~~ -- Create a branch to identify the issue you would like to work on (e.g. - ``2287-dry-test-suite``) -- Using your favorite editor, make your changes, `committing as you go`_. +- Create a branch to identify the issue you would like to work on:: + + git branch your-branch-name + +- Then switch to make sure that we are working on that branch by using:: + + git checkout your-branch-name + +- Using your favorite editor, make your changes, `committing as you go`_ by using the following:: + + git add -A + git commit + - Try to follow `PEP8`_, but you may ignore the line length limit if following it would make the code uglier. - Include tests that cover any code changes you make. Make sure the test fails without your patch. `Run the tests. `_. -- Push your commits to GitHub and `create a pull request`_. +- Push your commits to GitHub and `create a pull request`_ by using:: + + git push --set-upstream origin your-branch-name + - Celebrate 🎉 .. _committing as you go: http://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes From e61fd5f6cb1c7ebba86a9eef9c5e645d9c4032d1 Mon Sep 17 00:00:00 2001 From: David Lord Date: Thu, 16 May 2019 10:21:35 -0700 Subject: [PATCH 2/2] add instructions for bug and feature branches --- CONTRIBUTING.rst | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0fdc18b1..2f752e66 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -82,19 +82,18 @@ First time setup Start coding ~~~~~~~~~~~~ -- Create a branch to identify the issue you would like to work on:: +- Create a branch to identify the issue you would like to work on. If + you're submitting a bug or documentation fix, branch off of the + latest ".x" branch:: - git branch your-branch-name + git checkout -b your-branch-name origin/1.0.x -- Then switch to make sure that we are working on that branch by using:: + If you're submitting a feature addition or change, branch off of the + "master" branch:: - git checkout your-branch-name - -- Using your favorite editor, make your changes, `committing as you go`_ by using the following:: - - git add -A - git commit + git checkout -b your-branch-name origin/master +- Using your favorite editor, make your changes, `committing as you go`_. - Try to follow `PEP8`_, but you may ignore the line length limit if following it would make the code uglier. - Include tests that cover any code changes you make. Make sure the test fails