You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .coderabbit.yaml
+9-10Lines changed: 9 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,15 @@ reviews:
4
4
- path: "newsfragments/*.rst"
5
5
instructions: |
6
6
Validate newsfragment files:
7
-
1. Read valid types from [tool.towncrier.fragment] in pyproject.toml
8
-
2. Filename must follow the pattern: [number].[type].rst OR +[hash].[type].rst where:
9
-
- [number] is an issue number or PR number
10
-
- [type] must be one of the types defined in towncrier configuration
11
-
3. Content must be a clear, concise description of the change
12
-
4. Content should be suitable for inclusion in CHANGES.rst
13
-
5. Verify the type matches the nature of the change based on towncrier type definitions
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")
7
+
1. Read valid types from [tool.towncrier.type] in pyproject.toml.
8
+
2. Filename must follow one of these patterns:
9
+
- `[issue_number].[type].rst` — use this when a dedicated **issue** exists in the issue tracker.
10
+
- `+[hash].[type].rst` — use this (orphan format) when there is NO dedicated issue. A PR alone (without a backing issue) does NOT require the numbered format; orphan is acceptable.
11
+
Do NOT flag orphan fragments as incorrect when only a PR exists but no issue does.
12
+
3. Content must be a clear, concise description of the change (not just "fix" or "update").
13
+
4. Content should be suitable for inclusion in CHANGES.rst.
14
+
5. Verify the type matches the nature of the change based on towncrier type definitions.
15
+
6. Some changes may require multiple types, especially breaking changes.
0 commit comments