Skip to content

Latest commit

 

History

History
59 lines (47 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

59 lines (47 loc) · 2.31 KB

Contributing Guide

👋Thank you for taking the time to read this and I look forward to reviewing your contribution.

Contribution instructions:

  • 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.

Getting Started

  1. Run tests (Uses Jest)
    npm test
    npm test -- --watch
    
  2. Run integration tests npm run ui-tests
  3. Debug extension: Press F5 in VS Code to launch the extension into a sandbox and you can place break points
  4. Debug tests: In the debug tab you can change to jest from the dropdown
  5. 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

Releasing

This section is for owner/maintainers with publish access to git-mob-vs-code on the extension marketplace.

  1. 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
  2. Bump the version at the appropriate level (major, minor, patch); e.g.
    npm version patch
    
  3. Push the version commit and tag
    git push --follow-tags
    
  4. New releases need to be manually triggered GitHub publish action

You might need to regenerate PATs

  1. Never to be used only for reference: Manually release the package
    vsce publish -p <secret key>