This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
Link to the contributing guide if newsfragment check fails #8002
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.
There are now multiple cases of community contributors being confused about what to do when the newsfragment check fails:
When
python -m towncrier.check --compare-with=origin/develop
fails, it exits with error code1
, otherwise exit code0
when the check succeeds. We use this toecho
a link to the changelog contributing guide when the check fails, to hopefully allow contributors to be informed and solve the issue themselves.