Copy shared PR template, encourage changelog updates within PRs #980
Conversation
Copy it here so we can make edits specific for the Augur repo use case. https://github.com/nextstrain/.github/blob/24efb1981ec34b188535da9b1307076a06c1f3f3/.github/pull_request_template.md
Earlier commits in this PR encourage changelog updates with individual PRs, rather than a bulk collection during the release process. Updated the release process to reflect this new expectation.
|
One slight downside: merging a PR will most likely cause changelog merge conflicts on other open PRs. Conflict resolution on a PR would only be temporary if yet another PR gets merged first, so this could be an unnecessary chore for PRs that sit in review for a while. However, the merge conflicts should be trivial to solve. |
I'd recommend taking a look at towncrier, as it was designed to solve this sort of problem. |
|
@fanninpm Thanks for the suggestion. I suspect towncrier adds more process than we want to take on at the moment (compared to editing a single changelog file), but I can see it potentially being adopted in the future. |
Description of proposed changes
Implemented this idea from #975 (comment):
Related issue(s)
Testing
N/A