Our project welcomes external contributions. If you have an itch, please feel free to scratch it.
To contribute code or documentation, please submit a pull request.
A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the issue tracker.
If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.
If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.
The project maintainers use LGTM (Looks Good To Me) in comments on the code review to indicate acceptance. A change requires LGTMs from two of the maintainers of each component affected.
For a list of the maintainers, see the MAINTAINERS.md page.
Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. e.g.
Copyright <year> <holder> All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
This project uses NPM to handle dependencies and as a build tool, so you must have NodeJS and NPM installed.
Get NodeJS here.
Get NPM here.
This project has been set up so that on your local machine you cant lint, test and build easily and quickly. There are three commands you can use:
- npm run lint
- npm run test
- npm run build
Pull requests will only be accepted if they pass all tests. Karma is used as a testing framework, and the tests are run against Chrome and Firefox - so in order to run the tests you must have Chrome and Firefox installed. Tests can be run either on your fork through Travis CI, or locally using npm test.
Pull requests will only be accepted if they pass the linting. Linting can be run either on your fork through Travis CI, or locally using npm run lint.