From ef1fe756cb35a9c7b8c5ff1307125814c354df2e Mon Sep 17 00:00:00 2001 From: Koen Vlaswinkel Date: Wed, 8 Feb 2023 11:21:33 +0000 Subject: [PATCH] Add recommendation for version number bumps --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8854e269..a5e2dddd0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -228,6 +228,13 @@ Pre-recorded scenarios are stored in `./src/mocks/scenarios`. However, it's poss 1. Double-check the `CHANGELOG.md` contains all desired change comments and has the version to be released with date at the top. * Go through all recent PRs and make sure they are properly accounted for. * Make sure all changelog entries have links back to their PR(s) if appropriate. + * 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: + * Making substantial new features available to all users. This can include lifting a feature flag. + * Breakage in compatibility with recent versions of the CLI. + * Minimum required version of VS Code is increased. + * New telemetry events are added. + * Deprecation or removal of commands. + * 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. 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: * `.nvmrc` - this will enable `nvm` to automatically switch to the correct node version when you're in the project folder * `.github/workflows/main.yml` - all the "node-version: " settings