@@ -119,6 +119,36 @@ The repository includes PowerShell-based build scripts, but they require PowerSh
1191194 . ** Run linting** to catch issues early: ` yarn run lint `
1201205 . ** Test the PowerShell parser** if you modify localization logic
1211216 . ** 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:
134164yarn 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
0 commit comments