docs: revise CHANGELOG.md preparation instructions#3449
Merged
Conversation
Updated the instructions for preparing the CHANGELOG.md before releasing.
dotNomad
approved these changes
Feb 4, 2026
Collaborator
dotNomad
left a comment
dotNomad
left a comment
There was a problem hiding this comment.
Fantastic improvement 🎉
Updated instructions for creating and pushing tags in the release process.
dotNomad
approved these changes
Feb 5, 2026
Collaborator
dotNomad
left a comment
dotNomad
left a comment
There was a problem hiding this comment.
Thank you for the extra clarity here 
Collaborator
|
Looks like we'll just have to format prior to merging |
m--
changed the title
m--
changed the title
Updated instructions for documenting changes in CHANGELOG.md and syncing with VSCode extension changelog.
m--
commented
Feb 7, 2026
Comment on lines
-340
to
-344
| **Note:** The sync script: | ||
| - Preserves the VSCode extension-specific header | ||
| - Strips the `[Unreleased]` section | ||
| - Only includes releases from 1.1.3 onwards (the initial VSCode extension release) | ||
| - Pre-extension releases (1.1.2 and earlier) are excluded from the VSCode changelog |
Collaborator
Author
There was a problem hiding this comment.
Took this bit out as it's documented in the script, and now we link to that spot.
karawoo
approved these changes
Feb 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated the instructions for preparing the CHANGELOG.md before releasing.
Intent
Make the "update CHANGELOG" part of the Release steps more clear in
CONTRIBUTING.md.Type of Change
Approach
Describe in a bit more detail what we do for this part of the process.
User Impact
Hopefully this makes the process more clear!
Automated Tests
N/A
Directions for Reviewers
If the words make sense and are accurate, this is good. Suggestions, of course, are most welcome.
Checklist