Open mcmire opened 4 months ago
Is there anything keeping us from applying this practice as standard to all repos that rely on auto-changelog
and the create-release-pr
action? If not, would it be better to move docs/reviewing-release-prs.md
and the documentation articles proposed in this ticket into contributor-docs
?
We need documentation, update the PR template to include this in the check list, make a general announcement about this and push back on PRs that aren't doing this.
Currently, we ask that when contributors submit a PR, they add changelog entries within the description of that PR. When a new release PR is created, the manager of the release then copies over the various changelog entries from the PRs involved in that release to various changelogs.
This process is problematic for a few reasons:
Putting this together, changelog entries often get missed in reviews, so in preparing a release PR, the release manager must spend time gathering context about PRs they may not have created themselves in order to reword them appropriately. Ideally, the team who introduced the change are the best people to describe that change in the changelog, and the time during which a change is being introduced is the best time to update the changelog.
To fix this, we can ask that contributors update changelogs in their PRs. However, we have another problem, which is that people still don't quite know how to do this (we find we have to make all kinds of corrections in release PRs). We should not only communicate the new process but also provide a better guide for filling out changelogs than what we have today.
Acceptance Criteria
docs/
).docs/
.