...
- For changes that will need to be committed to both the release branch and master, make the initial PR against the release branch.
- Fill out the template on your pull request https://github.com/codice/ddf/blob/master/PULL_REQUEST_TEMPLATE.
- Create an appropriate title for the Pull Request.
Include the branch name in the PR title for a non-master branch. Indicating the branch on the title is helpful for reviewers.
Code Block title Backport PR [2.1013.x] DDF-9999 Good Ticket Title
Another helpful piece of information to give reviewers is to link the original master ticket (if applicable) at the top of the forwardport PR description, e.g:
Code Block ### Forwardport of https://github.com/codice/ddf/pulls/9999
If your PR is a work in progress (not ready to be merged or reviewed), indicate it with WIP (Work in progress).
Code Block [WIP] DDF-9999 Good Ticket Title
...
For the general case, merging is gated on the following, although certain exceptions may occur. For example, if there is a problem with the CI environment then a manually performed full build and static analysis check may be substituted at the discretion of the repository maintainers.
Review by at least two contributors
Review by at least two committers
Successful CI
Successful static analysis (SonarQube/Coverity/etc.)
Heroing of change (details vary by ticket)
- Abbreviated review process
- Repository metadata such as this
PULL_REQUEST_TEMPLATE
, the repositoryREADME
, and other non-functional items may be merged without requiring CI and static analysis An abbreviated review process may be in place for forward-port tickets immediately following branching and prior to branch divergence. In that case, approvals, CI, static analysis, and heroing that occur against the PR against the release branch can be considered sufficient for reviewing the PR against the master branch.
Once the branches diverge, the process will return to normal.
Insofar as divergence is not a function of time but of change to the parent branch, the repository maintainers will determine when abbreviated review ends.
When abbreviated review is in effect, a note to that effect will be at the top of this template. Following is an example note:
Code Block title Example Abbreviated Review ##### ABBREVIATED REVIEW BETWEEN 2.1213.X AND MASTER IS IN EFFECT ____
- Repository metadata such as this
...