CONTRIBUTING.md

Contributing

Hi there,

Thank you for taking interest in this project, and thank you for considering making a contribution to this project.

Contributions are certainly welcome here!

Starting your contribution

When contributing to this repository, please either drop a comment on an open issue to say you want to work on that issue OR first discuss the change you wish to make by creating an issue on the GitHub page:

• For bug reports use this template.
• For feature requests use this template.
• For questions no template is required, but please be as informative as possible.

Pull Request Process

Once your contribution is ready to be added to the project, please do the following:

1. Ensure linting standards are conformed to.
2. If new code is written, ensure that unit tests have been writen to cover the new code.
3. Update the changelog. Add details of your update to the appropriate section beneath "Unreleased". Our changelogs are based on KEEPACHANGELOG.
4. If required, update the README or other related documentation with details of the change.
5. Follow the Pull Request template. It is in place to make pull requests easier to review.
6. Assign jringram as a reviewer.

Running the tests

• npm run tsc to run typescript compiler.
• npm run test to run jest tests.
• npm run lint to run linter.
• test:e2e:firefox and test:e2e:chrome to run end-to-end tests for the respective browsers.