|
@@ -202,12 +202,46 @@ include the following:
|
|
|
* Reference to an issue if the change is related to one of the issues on our
|
|
|
GitHub page.
|
|
|
* Documentation updates in the ``docs/`` directory describing your change.
|
|
|
+* Unit tests, or a description of how the change was manually tested.
|
|
|
|
|
|
Following submission of your pull request, a CodeRed member will review and test
|
|
|
your change. **All changes, even by CodeRed members, must go through a pull
|
|
|
request process to ensure quality.**
|
|
|
|
|
|
|
|
|
+Merging Pull Requests
|
|
|
+---------------------
|
|
|
+
|
|
|
+Follow these guidelines to merge a pull request into the master branch:
|
|
|
+
|
|
|
+* Unit tests pass.
|
|
|
+* Code coverage is not lower than master branch.
|
|
|
+* Documentation builds, and the PR provides documentation (release notes at a
|
|
|
+ minimum).
|
|
|
+* If there is a related issue, the issue is referenced and/or closed (if
|
|
|
+ applicable)
|
|
|
+* Finally, always make a squash merge with a single descriptive commit message.
|
|
|
+ Avoid simply using the default commit message generated by GitHub if it is a
|
|
|
+ summary of previous commits or is not descriptive of the change.
|
|
|
+
|
|
|
+In the event that the pull request needs more work that the author is unable to
|
|
|
+provide, the following process should be followed:
|
|
|
+
|
|
|
+* Create a new branch from master in the form of ``merge/pr-123`` where 123 is
|
|
|
+ the original pull request number.
|
|
|
+* Edit the pull request to merge into the new branch instead of master.
|
|
|
+* Make the necessary changes and submit for review using the normal process.
|
|
|
+* When merging this branch into master, follow the same process above, but be
|
|
|
+ sure to credit the original author(s) by adding their names to the bottom of
|
|
|
+ the commit message as so (see
|
|
|
+ `GitHub documentation <https://help.github.com/en/articles/creating-a-commit-with-multiple-authors>`_):
|
|
|
+
|
|
|
+ .. code-block:: text
|
|
|
+
|
|
|
+ Co-authored-by: name <name@example.com>
|
|
|
+ Co-authored-by: another-name <another-name@example.com>
|
|
|
+
|
|
|
+
|
|
|
Building Python Packages
|
|
|
------------------------
|
|
|
|