CONTRIBUTING.md

Contributing Guide

Getting Started

1. Install dependencies

   npm install
   

2. Run linter and tests

   npm run checks
   

Other test commands

• Run a test file

  npm test ./dist/git-mob.spec.js
  

See Ava for more options. This is for git-mob package.

Jest is used for git-mob-core package.

Asserting prompts on the cli using coffee.

Releasing

This section is for maintainers with push access to git-mob on npm.

Git Mob uses workspaces now and the flags below are needed to version each of the packages.

Read more about workspaces for version command. Using workspaces flag runs the version command in all packages

Versioning

1. Version a package

   npm version minor --workspace=git-mob
   

2. Or all packages

   npm version patch --workspaces
   

3. Commit and push

Releasing

1. Bump the root package version and this will make a git tag (major, minor, patch); e.g.

   npm version patch
   

2. Git Push
3. Run the publish CI GitHub actions
4. Release notes added here https://github.com/rkotze/git-mob/releases