Contributing

Development

We use RushJS to manage this repository. Some quick notes on how to manage the repository are documented here.

Install dependencies -- You only need to run this once.

npm install -g @microsoft/rush

Update packages -- Run this if you add/remove packages from this repository.

rush update --full

Rebuild and test -- Do this each time you make changes to the code

rush rebuild --verbose
rush test --verbose

The above notes will help you decide which commands to run during development on your own machine. But for any commits and pull requests in this repository, the entire test suite will be run using continuous integration.

Issues

We use GitHub issues to track bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Pull requests

Always fork the repo and create your branch from master. If you've added code that should be tested, add tests. Alsp ensure the test suite passes before submitting the PR.

Coding style

Please follow the TypeScript coding guidelines.

You should prefix private and protected class variables with _. Public class variables should start with a letter. Public class variables which hold read-only configuration information should be prefixed with __.

Release process

The release manager will publish packages to NPM using these commands.

$ rush version --bump --override-bump minor
$ rush update --full
$ rush rebuild
$ rush test
$ rush publish --publish --include-all