Permalink
Browse files

Merge pull request #57 from wagnerand/bestpractices

Move 'Best practices' to a more prominent place
  • Loading branch information...
2 parents ba45cc5 + 035faf2 commit 2397746713fa3c986781d008db62262247fedeb4 @tofumatt tofumatt committed May 19, 2016
Showing with 20 additions and 12 deletions.
  1. +16 −0 guide/best-practices.rst
  2. +1 −0 guide/index.rst
  3. +3 −12 reference/git_github.rst
View
@@ -0,0 +1,16 @@
+Best Practices
+==============
+
+.. _best-practices-github:
+
+Git and Github
+--------------
+
+- Create a separate pull request for each bug.
+- If you have multiple commits in one pull request, squash them into one. For complex patches, having multiple commits might make the review easier.
+- If you are working with multiple bugs at a time, make sure you create a separate branches for each bug.
+- If you need to make changes to the commit, perhaps after feedback, amend the original commit and comment in the pull request what you've changed. Don't create a new pull request or commit.
+- Include the bug number in your commit & pull request title. If possible follow this style -`Some text description (bug XXXXXXX)`.
+- Don't work on an assigned bug. If you see the bug assignee hasn’t responded for a while (two weeks), then ask for permission if you can work on that bug.
+- For frontend pull requests, attach screenshots if relevant.
+- Put a link to the PR in the bug as a comment.
View
@@ -20,3 +20,4 @@ Let's get started!
software
projects
development_process
+ best-practices
View
@@ -1,18 +1,9 @@
+
Git and Github
==============
-This document describes some best practices for using Git and Github.
-
-Best practises
---------------
-- Create a separate pull request for each bug.
-- If you have multiple commits in one pull request, squash them into one. For complex patches, having multiple commits might make the review easier.
-- If you are working with multiple bugs at a time, make sure you create a separate branches for each bug.
-- If you need to make changes to the commit, perhaps after feedback, amend the original commit and comment in the pull request what you've changed. Don't create a new pull request or commit.
-- Include the bug number in your commit & pull request title. If possible follow this style -`Some text description (bug XXXXXXX)`.
-- Don't work on an assigned bug. If you see the bug assignee hasn’t responded for a while (two weeks), then ask for permission if you can work on that bug.
-- For frontend pull requests, attach screenshots if relevant.
-- Put a link to the PR in the bug as a comment.
+This document describes some tips and tricks for using Git and Github.
+There are also some best practices for :ref:`best-practices-github`.
Commit Messages
---------------

0 comments on commit 2397746

Please sign in to comment.