File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -11,8 +11,9 @@ reviews:
1111 3. Content must be a clear, concise description of the change
1212 4. Content should be suitable for inclusion in CHANGES.rst
1313 5. Verify the type matches the nature of the change based on towncrier type definitions
14- 6. Flag any files with invalid types or malformed filenames
15- 7. Check that the description is meaningful (not just "fix" or "update")
14+ 6. Some changes may require multiple types. Especially breaking changes
15+ 7. Flag any files with invalid types or malformed filenames
16+ 8. Check that the description is meaningful (not just "fix" or "update")
1617
1718 pre_merge_checks :
1819 custom_checks :
@@ -22,6 +23,6 @@ reviews:
2223 Check if a newsfragment file has been added to the newsfragments/ directory.
2324 Read the towncrier configuration from pyproject.toml to determine valid newsfragment types.
2425 If no newsfragment is present, suggest which type should be added based on the PR changes.
25- Suggest the filename format: [issue_or_pr_number].[type].rst
26- Remind contributors to use: `pipenv run towncrier create [number].[type].rst`
26+ Suggest the filename format: [issue_or_pr_number].[type].rst (or +[hash].[type].rst for orphan fragments)
27+ Remind contributors to use: `pipenv run towncrier create [number].[type].rst` (or `pipenv run towncrier create +.[type]` for orphan fragments)
2728 Skip the check if the PR only updates existing newsfragments or is a trivial change.
You can’t perform that action at this time.
0 commit comments