See JENKINS-XXXXX.
- Entry 1: Issue, Human-readable Text
- ...
N/A
- (If applicable) Jira issue is well described
- Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change) and are in the imperative mood. Examples
- Fill-in the
Proposed changelog entriessection only if there are breaking changes or other changes which may require extra steps from users during the upgrade
- Fill-in the
- Appropriate autotests or explanation to why this change has no tests
- New public classes, fields, and methods are annotated with
@Restrictedor have@since TODOJavadoc, as appropriate. - New deprecations are annotated with
@Deprecated(since = "TODO")or@Deprecated(forRemoval = true, since = "TODO")if applicable. - For dependency updates: links to external changelogs and, if possible, full diffs
@mention
Before the changes are marked as ready-for-merge:
- There are at least 2 approvals for the pull request and no outstanding requests for change
- Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
- Changelog entries in the PR title and/or
Proposed changelog entriesare accurate, human-readable, and in the imperative mood - Proper changelog labels are set so that the changelog can be generated automatically
- If the change needs additional upgrade steps from users,
upgrade-guide-neededlabel is set and there is aProposed upgrade guidelinessection in the PR title. (example) - If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as
lts-candidateto be considered (see query).