|
| 1 | +--- |
| 2 | +applyTo: 'CHANGELOG.md' |
| 3 | +--- |
| 4 | + |
| 5 | +Do not edit the file unless explicitly requested by the user. |
| 6 | +When releasing a new version, you will be asked to create a new section in the `CHANGELOG.md` file for the version based on "Unreleased Changes". |
| 7 | + |
| 8 | +# Style guidelines |
| 9 | + |
| 10 | +- Use semantic versioning headings (e.g., ## <version>) |
| 11 | +- Release candidates are supported with version suffix format (e.g., `0.5.0-rc.1` should be labeled as "0.5.0 (Release Candidate 1)" in the changelog) |
| 12 | +- Do not use subheadings |
| 13 | +- Do not mention commit hashes |
| 14 | +- Write in past tense (e.g., "improved", "introduced", "added") |
| 15 | +- Balance technical accuracy with user-facing language |
| 16 | +- Use bullet points for individual changes |
| 17 | + |
| 18 | +# Content guidelines |
| 19 | + |
| 20 | +- Entries should be concise but can include technical details relevant to users |
| 21 | +- Write a bullet point for every new, changed, fixed, or removed feature |
| 22 | +- Do not use emojis |
| 23 | +- Include both user benefits and technical specifics when relevant |
| 24 | + |
| 25 | +# Writing patterns |
| 26 | + |
| 27 | +## Change descriptions |
| 28 | + |
| 29 | +- **New tools/features**: "Added [tool/feature name] [brief description]" |
| 30 | +- **Improvements**: "Improved [component] to [specific enhancement]" |
| 31 | +- **Bug fixes**: "Fixed [issue description]" or "Fixed: [specific problem]" |
| 32 | +- **Removals**: "Removed [item] [reason if relevant]" |
| 33 | +- **Technical changes**: Include scope changes, API modifications, and architectural improvements |
| 34 | + |
| 35 | +## User-centric language |
| 36 | + |
| 37 | +- Emphasize user capabilities: "You can now...", "You will now find...", "It is now possible to..." |
| 38 | +- Explain business value: "enabling more precise...", "providing greater flexibility...", "ensuring smoother performance..." |
| 39 | +- Use positive framing: "enhanced", "improved", "better", "more accurate" |
| 40 | + |
| 41 | +## Technical details to include |
| 42 | + |
| 43 | +- Tool additions, modifications, and removals |
| 44 | +- Scope changes and OAuth permissions |
| 45 | +- API endpoint changes that affect users |
| 46 | +- Performance improvements with specific impacts |
| 47 | +- Breaking changes with migration guidance |
0 commit comments