diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..41b0c14 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +#### Description of Work + +Fixes + +#### Testing Instructions + +1. +2. +3. + diff --git a/docs/source/workflow.rst b/docs/source/workflow.rst index 5619672..7e9640e 100644 --- a/docs/source/workflow.rst +++ b/docs/source/workflow.rst @@ -40,11 +40,16 @@ The workflow for private developments is as follows: 3. Commit all changes outlined in the issue to this branch and push branch to the private ERSEM repo. 4. Create `pull request `_ to merge the branch you have made the changes on into the `master` branch. In the creation of the pull request you - will need to assign specific people to review the changes you have made before it can be merged into the master branch. + will need to assign specific people to review the changes you have made before it can be merged into the master branch. 5. Once the updates have been approved by the reviewer/reviewers they will merge the development into the master branch. 6. When the private master branch is updated you will need to talk to the ERSEM repo manager to merge those changes back to the public repo. +.. note:: + + When creating the pull request it is important to add `Fixes #[issue-id-number]`, this will insure that when the + pull request is merged into master the corresponding issue will be closed at the same time. + Public developments ------------------- @@ -76,6 +81,11 @@ For public developments, the workflow is pretty simple: 6. When the public master branch is updated you will need to talk to the ERSEM repo manager to merge those changes back to the private repo. +.. note:: + + When creating the pull request it is important to add `Fixes #[issue-id-number]`, this will insure that when the + pull request is merged into master the corresponding issue will be closed at the same time. + Notes for reviewers ------------------- @@ -84,7 +94,8 @@ When `reviewing pull requests