Skip to content

Commit ef1fe75

Browse files
committed
Add recommendation for version number bumps
1 parent 81502fe commit ef1fe75

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,13 @@ Pre-recorded scenarios are stored in `./src/mocks/scenarios`. However, it's poss
228228
1. Double-check the `CHANGELOG.md` contains all desired change comments and has the version to be released with date at the top.
229229
* Go through all recent PRs and make sure they are properly accounted for.
230230
* Make sure all changelog entries have links back to their PR(s) if appropriate.
231+
* For picking the new version number, we default to increasing the patch version number, but make our own judgement about whether a change is big enough to warrant a minor version bump. Common reasons for a minor bump could include:
232+
* Making substantial new features available to all users. This can include lifting a feature flag.
233+
* Breakage in compatibility with recent versions of the CLI.
234+
* Minimum required version of VS Code is increased.
235+
* New telemetry events are added.
236+
* Deprecation or removal of commands.
237+
* Accumulation of many changes, none of which are individually big enough to warrant a minor bump, but which together are. This does not include changes which are purely internal to the extension, such as refactoring, or which are only available behind a feature flag.
231238
1. Double-check that the node version we're using matches the one used for VS Code. If it doesn't, you will then need to update the node version in the following files:
232239
* `.nvmrc` - this will enable `nvm` to automatically switch to the correct node version when you're in the project folder
233240
* `.github/workflows/main.yml` - all the "node-version: <version>" settings

0 commit comments

Comments
 (0)