Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.67 KB
Raw

Contributing

Guidelines for pull requests

  • Write tests for any changes
  • Follow existing code style and conventions
  • Separate unrelated changes into multiple pull requests
  • For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change
  • Use conventional changelog conventions in your commit messages

Development dependencies

  • nvm 0.30.2

Setting up a development machine

Install nodejs

nvm install

Install project dependencies

npm install

Ensure your environment is working by running the pre-commit check

npm test

During development

Commits to this codebase should follow the conventional changelog conventions.

To get fast test feedback run npm run watch in one terminal window and npm run watch-e2e in another.

  • npm test - A pre-commit check to be run before pushing any changes.
  • npm run watch - Automatically compiles the code and runs the unit tests whenever you edit a relevant file.
  • npm run watch-e2e - Automatically runs the e2e tests whenever you edit a relevant file. This command does not compile the code and must be run in combination with the watch command.

Releasing a new version

This project is versioned using Semantic Versioning.

  • npm run release-patch - Publishes a patch version to npm, e.g. 1.0.0 -> 1.0.1
  • npm run release-minor - Publishes a minor version to npm, e.g. 1.0.0 -> 1.1.0
  • npm run release-major - Publishes a major version to npm, e.g. 1.0.0 -> 2.0.0