From 8de5ffb2ff0afa5908cf0bacdb62ace20d477d4c Mon Sep 17 00:00:00 2001 From: William Killerud Date: Sun, 19 Nov 2023 15:53:41 +0100 Subject: [PATCH] docs: mention conventional commits --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ec57ddf..776825ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,11 +6,23 @@ Before you start, please make a new Issue. I don't always make new issues for al If you open a pull request, please **make sure to set the correct target**. This is a fork, and GitHub defaults to using the source repository as a target for pull requests. Please don't create needless noise in the upstream repository. The correct target is `wkillerud/vscode-scss` and the branch `main`. +## Conventional commits + +This repo uses [conventional commits and `semantic-release`](https://github.com/semantic-release/semantic-release#how-does-it-work) to automatically publish changes merged to `main`. + +While not a library, stick to something resembling semantic versioning when writing commit messages. + +| Commit message | Release type | +| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `fix: update css-languageservice` | Patch. Bugfix release, updates for runtime dependencies. | +| `feat: add support for show keyword in forward` | Minor. New feature release. | +| `refactor: remove reduntant options for latest language version`

`BREAKING CHANGE: The scanImportedFiles option has been removed.` | Major. Breaking release, like removing an option or changing `engines` version.
(Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) | + ## Development environment You will need these things installed: -- Node.js +- Node.js LTS - Visual Studio Code stable - The extension _TypeScript + Webpack Problem Matchers_ (`amodio.tsl-problem-matcher`)