|
9 | 9 | 8. Software name capitalisation — Live (the software) and version refs like Live 12 are always capitalised. |
10 | 10 | 9. Grammar: allows/enables to — allows to and enables to are grammatically wrong. Use allows you to or lets you. |
11 | 11 | 10. Paragraph length — Max 4 sentences per paragraph. (Not enforced in Free mode) |
12 | | -11. Passive voice — Avoid was added, has been updated, can be accessed. Use active voice. |
| 12 | +11. ~~Passive voice — Avoid was added, has been updated, can be accessed. Use active voice.~~ |
13 | 13 | 12. Bug fix structure (Bug Fix mode) — Must describe both: what broke AND what now works. |
14 | 14 | 13. Release note structure (Release Note mode) — Must lead with what the user can now DO. |
15 | 15 | 14. Minimize words — Cut simply, just, easily, obviously, of course, clearly — they make tasks sound trivial. |
16 | 16 | 15. Weak sentence opener — Avoid starting sentences with There is/are or It is. Lead with the real subject. |
17 | 17 | 16. Redundant phrasing — in order to → to, due to the fact that → because, at this point in time → now, etc. |
18 | | -17. Filler phrases — Cut please note, note that, it is worth noting, as you can see, etc. |
| 18 | +17. ~~Filler phrases — Cut please note, note that, it is worth noting, as you can see, etc.~~ |
| 19 | + |
| 20 | +> **correction**: Note that is allowed |
| 21 | +
|
19 | 22 | 18. Double spaces — Single space between words and after punctuation. |
20 | 23 | 19. Trailing ellipsis — ... at the end of a sentence implies an unfinished thought. |
21 | 24 | 20. Avoid etc. — Complete the list or write and |
22 | 25 | 21. Parameter Values - place parameter values in double quotes. 100% is "100%". |
23 | 26 |
|
24 | 27 | **Release Note Only** |
| 28 | + |
25 | 29 | 1. Release note structure — must describe what the user can now DO (looks for: "can now", "lets you", "allows you", "use", "select", "access", etc.) |
26 | 30 |
|
27 | 31 | # Bug Fix Rules |
28 | 32 |
|
29 | | -1. Always lead with "Fixed" — "Fixed an issue where...", "Fixed a bug where...", "Fixed a crash that occurred when..." |
| 33 | +1. ~~Always lead with "Fixed" — "Fixed an issue where...", "Fixed a bug where...", "Fixed a crash that occurred when..."~~ |
| 34 | + |
| 35 | +> **correction**: those are suggestions ... |
| 36 | +
|
30 | 37 | 2. Platform-specific bugs — name the platform first. "Fixed an issue on macOS where...", "Fixed an issue on Windows where..." |
31 | 38 | 3. Describe the trigger — what action or condition caused the bug. Be specific. |
32 | 39 | 4. Describe the outcome — what now works. Can be a second sentence: "X now Y." |
33 | 40 | 5. Passive voice IS allowed here — "Fixed an issue where X was not Y" is the standard form. The linter skips passive checks in Bug Fix mode. |
34 | 41 | 6. Use bullet points for multiple related fixes in the same release. |
35 | | -7. No crash without a trigger — "Fixed a crash" alone is not enough. State what caused it. |
36 | | -8. All standard rules still apply — American English, UI element caps, no marketing, no dev jargon, no contractions, acronym caps, etc. |
| 42 | +7. ~~No crash without a trigger — "Fixed a crash" alone is not enough. State what caused it.~~ |
| 43 | + |
| 44 | +> **correction**: those are suggestions ... |
| 45 | +
|
| 46 | +8. All standard rules still apply — American English, UI element caps, no marketing, no dev jargon, no contractions, acronym caps, etc. |
| 47 | + |
| 48 | +9. Max 2 sentences.. or as short as possible. |
| 49 | + |
| 50 | +10. Improvements, features and more - start with the main subject instead of "Fixed" |
0 commit comments