Commit 45c9307
[TASK] Clarify Resolves requirement in commit message guide (#404)
* [TASK] Clarify Resolves requirement in commit message guide
Make it explicit that 'Resolves:' is required and 'Related:' is
optional. The commit-msg hook rejects commits without at least one
'Resolves:' line, but this was not clearly stated in the documentation.
Changes:
* Mark 'Resolves:' as (REQUIRED) and clarify it is mandatory
* Add note that commit-msg hook rejects commits without Resolves
* Mark 'Related:' as (OPTIONAL) and clarify it cannot be used alone
* Emphasize that at least one 'Resolves:' line is needed
This addresses confusion where contributors used only 'Related:' and
had their commits rejected.
* [DOCS] Language checks
Releases: main
---------
Co-authored-by: Sarah McCarthy <[email protected]>1 parent ff4f018 commit 45c9307
1 file changed
+14
-12
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
14 | | - | |
| 13 | + | |
| 14 | + | |
15 | 15 | | |
16 | | - | |
17 | | - | |
18 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
240 | 240 | | |
241 | 241 | | |
242 | 242 | | |
243 | | - | |
244 | | - | |
245 | | - | |
246 | | - | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
247 | 248 | | |
248 | 249 | | |
249 | 250 | | |
| |||
260 | 261 | | |
261 | 262 | | |
262 | 263 | | |
263 | | - | |
| 264 | + | |
264 | 265 | | |
265 | | - | |
266 | | - | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
267 | 269 | | |
268 | 270 | | |
269 | 271 | | |
| |||
0 commit comments