Hi, and thanks for your interest in contributing!
Scuri code is a VS Code extension which allows for seemless integration of scuri in the VS Code editor commands.
- please, let's discuss the feature/bug in the issues
- if it's missing - please open a new issue and let's discuss there
- start a discussion in the issues
- fork the project fork
- work in a branch
feature/my-awesome-feature-request - open a PR and please add some tests for what you've experienced/corrected/added
Tests are using mocha and live inside src/test folder e.g. src/test/path-with-spaces.test.ts
Please see testing VS Code extensions for more details.
Please see details in the official guide - link
We are using a couple of libraries to setup our process of contributing:
- husky - will run a pre-commit step to verify that the commit message adheres to Angular standard commit
- semantic-release takes care of release based on the commits - check out their great docs but in short
fixwill create new patch version 1.0.5 -> 1.0.6featwill create new minor version 1.0.6 -> 1.1.0BREAKING CHANGEwill create new major version 1.1.0 -> 2.0.0
- we use the standard format based on Keep a Changelog
- we utilize GitHub actions to build and release our libraries (see
.github/workflows/release-forms-typed.yml, etc.)
Marketplace does not support prerelease so we only have a stable release channel
All of the above means that when preparing your PR you'll have to:
- adhere to the commit standard (and we have a pre-commit step that will fail your commit if you don't)
- add a line to the project's
Changelog.md(this is not automated) - add a test or two for your change
Look into the following to make sense on the release process
- semantic release - publish recipe
This is what an error looks like in the console and in the VS Code (on Windows). An acceptable message would be chore:fix typo
