Skip to content

Commit

Permalink
Add review process, limit TOC at 2 levels
Browse files Browse the repository at this point in the history
  • Loading branch information
trasher committed Oct 3, 2016
1 parent 6ba4fbc commit 86194ab
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
3 changes: 2 additions & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ GLPi Developer Documentation
:align: center

.. toctree::
:maxdepth: 3
:maxdepth: 2

sourcecode
codingstandards
reviewprocess
plugins
20 changes: 20 additions & 0 deletions source/reviewprocess.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Review process
==============

Here is the process you must follow when you are reviewing a PR.

1. Make sure the destination branch is the correct one:

* `master` for new features,
* `xx/bugfixes` for bug fixes

2. Check if unit tests are not failing,
3. Check if coding standards checks are not failing,
4. Review the code itself. It must follow :doc:`GLPi's coding standards <codingstandards>`,
5. Using the Github review process, approve, request changes or just comment the PR,

* If some new methods are added, or if the request made important changes in the code, you should ask the developer to write some more unit tests

6. A PR can be merged back if two developers approved it, or if one developer approved it more than one day ago,
7. A bugfix PR that has been merged into the `xx/bugfixes` branch must be reported on the `master` branch. If the `master` already contains many changes, you may have to change some code before doing this. f changes are consequent, maybe should you open a new PR against the `master` branch for it,
8. Say thanks to the contributor :-)

0 comments on commit 86194ab

Please sign in to comment.