Require change log entries to be include in the pull request#15475
Merged
Conversation
michaelDCurran
approved these changes
Sep 20, 2023
5 tasks
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of the issue:
Change log entries from contributors are currently requested to be included in the PR description rather than code changes.
This is because entries are prone to merge conflicts, however GitHub allows you to handle these through the web UX.
Alternatively, NV Access can always resolve these via git locally.
Change log entries in the PR description are harder to review, as you cannot make suggestions using GitHub's PR review UX.
This also adds unnecessary work for NV Access, to checkout PRs and copy paste the changes.
Description of user facing changes
contributors are encouraged to add changes directly to the changes file rather than the PR description