👋Thank you for taking the time to read this and I look forward to reviewing your contribution.
- Create a fork of the project on Github.
- Clone the fork on your local machine. Your remote repo on Github is called
origin
. - Add the original repository as a remote called
upstream
. - If you created your fork a while ago be sure to pull upstream changes into your local repository.
- Create a new branch to work on! Branch from
master
. - Please make an issue to reference and implement/fix your feature.
- Please add unit tests, jest is the testing tool.
- Make a pull request (PR) to merge into
master
and make sure it passes the continuous integration pipeline. - Ensure linting and unit tests all pass before submitting your PR. Run command
npm run ci
. - Ensure integration tests are all passing
npm run ui-tests
. - You're PR will be reviewed as soon as possible.
- Run tests (Uses Jest)
npm test npm test -- --watch
- Run integration tests
npm run ui-tests
- Debug extension: Press F5 in VS Code to launch the extension into a sandbox and you can place break points
- Debug tests: In the debug tab you can change to
jest
from the dropdown - Optional - Install latest version of
git-mob
. Useful to check it's keeping in sync with CLI.npm i -g git-mob
List of available VS Code icons
This section is for owner/maintainers with publish access to git-mob-vs-code on the extension marketplace.
- Add release notes at https://github.com/rkotze/git-mob-vs-code/releases and update the CHANGELOG https://github.com/rkotze/git-mob-vs-code/blob/master/CHANGELOG.md
- Bump the version at the appropriate level (major, minor, patch); e.g.
npm version patch
- Push the version commit and tag
git push --follow-tags
- New releases need to be manually triggered GitHub publish action
You might need to regenerate PATs
- Never to be used only for reference: Manually release the package
vsce publish -p <secret key>