Skip to content
This repository was archived by the owner on Jul 4, 2023. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (30 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.54 KB

Contributing

Raising issues/getting help

  • Use the Bug template for bugs
  • Use the Feature template for feature requests/behaviour changes/suggestions
  • For questions or anything else, create an issue as normal

Development

  1. Clone the repo
  2. npm install
  3. Open a second terminal and run npm run compile -- -w in the background. This is necessary to run the acceptance tests

Running the tests

  • npm run test:watch to run tests in watch mode during development
  • npm run test:unit to run unit tests only
  • npm run test:integration to run integration tests only
  • npm run test:acceptance to run acceptance tests only

Running the tests in docker

You may want to run the tests in a docker container to get around any weird machine specific issues or bugs.

  • docker-compose up --build unit-tests to run unit tests only
  • docker-compose up --build integration-tests to run integration tests only
  • docker-compose up --build acceptance-tests to run acceptance tests only

PRs

When you open a PR, tests and coverage checks will be run in a CI pipeline automatically. Everything needs to pass before it can be merged. I'm happy to help out with PRs/give guidance.

Adding support for new versions of typescript:

This is controlled by the Support latest typescript version workflow (upgrade-typescript.yml). It runs twice a day but can be triggered manually from the Actions tab in github.

Releases

A note on releasing - pre-release branches should be merged with no-ff