Skip to content

Commit 1f01b40

Browse files
Add changelog update instructions to Copilot guidelines (#9)
* Initial plan * Add changelog update instructions to Copilot guidelines Co-authored-by: HeyItsGilbert <615265+HeyItsGilbert@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: HeyItsGilbert <615265+HeyItsGilbert@users.noreply.github.com>
1 parent 8d21d95 commit 1f01b40

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,36 @@ The repository includes PowerShell-based build scripts, but they require PowerSh
119119
4. **Run linting** to catch issues early: `yarn run lint`
120120
5. **Test the PowerShell parser** if you modify localization logic
121121
6. **Package the extension** to ensure no packaging issues: `vsce package --allow-missing-repository`
122+
7. **Update the changelog** for every PR (see Changelog Updates section below)
123+
124+
### Changelog Updates
125+
126+
**REQUIRED FOR EVERY PR**: Update the CHANGELOG.md file following the [Keep a Changelog](http://keepachangelog.com/) format.
127+
128+
**Process:**
129+
1. **Add your changes** to the "Unreleased" section at the top of `CHANGELOG.md`
130+
2. **Use appropriate categories** for your changes:
131+
- **Added** - for new features
132+
- **Changed** - for changes in existing functionality
133+
- **Deprecated** - for soon-to-be removed features
134+
- **Removed** - for now removed features
135+
- **Fixed** - for any bug fixes
136+
- **Security** - in case of vulnerabilities
137+
3. **Write clear descriptions** that help users understand the impact of changes
138+
4. **Keep entries concise** but descriptive enough for users to understand what changed
139+
140+
**Example changelog entry:**
141+
```markdown
142+
## [Unreleased]
143+
144+
### Added
145+
- New PowerShell localization parsing feature for multi-language support
146+
147+
### Fixed
148+
- Resolved issue with decoration provider not updating on file changes
149+
```
150+
151+
**Note**: The "Unreleased" section will be converted to a version number during releases. Your job is only to add entries to the "Unreleased" section.
122152

123153
### Key Commands for Development
124154

@@ -134,6 +164,11 @@ Before completing any change, always run:
134164
yarn run lint && yarn run compile && vsce package --allow-missing-repository
135165
```
136166

167+
**Also verify:**
168+
- [ ] CHANGELOG.md has been updated with your changes in the "Unreleased" section
169+
- [ ] Changelog entries follow Keep a Changelog format with appropriate categories
170+
- [ ] Changelog descriptions are clear and user-focused
171+
137172
## Architecture Overview
138173

139174
### Key Projects and Components

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ to structure this file.
99
## [Unreleased]
1010

1111
### Added
12+
- Changelog update instructions to Copilot instructions
13+
- Clear process for updating CHANGELOG.md for every PR
14+
- Guidelines for using Keep a Changelog format categories
15+
- Examples and validation checklist for changelog entries
1216
- Configurable logging levels to control debug message visibility
1317
- New `powershellLocalization.logLevel` setting with four hierarchical levels:
1418
- `error` - Only error messages

0 commit comments

Comments
 (0)