When the Jira issue is included in the changelog summary, it is included
in the generated changelog as the initial text of the changelog entry.
The same issue link is then included by the changelog generator at the end
of the changelog description. Remove the example that places the issue at
the start of the changelog text and explain that the issue link should be
elsewhere in the pull request so that the changelog generator can use it.
When the Jira issue is included in the changelog summary, the changelog
maintainers must remove it before the changelog is published. It is
better to not include the Jira issue in the changelog summary so that
changelog maintainers do not need to remove it.
Remind submitters that they should not delete the upgrade guidelines
section because the presence of the upgrade guidelines section is used
by the changelog generator as the terminator for the proposed changelog
entries.
GitHub task lists do not support indented lists yet
When I submitted https://github.com/jenkinsci/jenkins/pull/8118 , the
task list failed to render until I removed the indented list item
* Add the maintainer checklist to the pull request template
* Add checklist items for LTS
* Add "Proposed changelog entries" to the pull request template
* Pull request template: `Internal: ` prefix is now added automatically by the Core Changelog generator
https://github.com/jenkinsci/jenkins-core-changelog-generator/pull/6
* Apply suggestions from review by @MarkEWaite
Co-Authored-By: Mark Waite <mark.earl.waite@gmail.com>
Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>
* Update PULL_REQUEST_TEMPLATE.md
Removed a defunct hyperlink and placed an intuitive directive in its place.
* Updated PULL_REQUEST_TEMPLATE.md to include comment
* Updated PULL_REQUEST_TEMPLATE.md to include lts backporting
* Remove the description header. It is confusing because commit message body goes before it
* Explicitly require human-readable changelogs
* Explicitly require links to the external changelogs/diffs
* Introduce the pull-request template.
This change xplicitly sets expectations from pull requests.
Reason:
* Highlight the need in autotests and JIRA issues for bugfixes
* ask PR creators to propose the changelog entries for their changes.
* Provide hints about referencing people
* Move the pull request template to .github
