Thank you for your invested time to make this project even better. This guide supports developers in contributing issues and code.
When opening an issue, describe your issue as clear as possible. If useful, provide code or an example repository.
This project uses the GitHub Flow.
The following commands support you at developing good code:
npm run code-analysis: Run the static code analysisnpm run test: Run the testsnpm run lint: Run the linter
Refer to this blogpost by cbeams when committing changes. Issue numbers can be added in braces to the end of the commit message.
It is also required to test your changes. Detailled information about test coverage will be published to coveralls.
Remember to
- bump a version,
- update
CHANGELOG.mdandREADME.md
After the pull request is merged, a tag can be created. When pushing a tag, GitHub Actions will automatically push the packaged project to the Visual Studio Marketplace and Open VSX Registry.
This is done by executing the commands:
vsce publish -p TOKEN --packagePath PACKAGE.vsix
npx ovsx publish -p TOKEN PACKAGE.vsix
Get tokens under:
- https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token
- https://open-vsx.org/user-settings/tokens
Find analysis on sonarcloud.io
Find analysis on deepsource.io
Find analysis on codefactor.io
Find analysis on snyk.io