The Badges above demonstrate testing, code coverage
and commitment to coding standards (since the code is linted on commit).
The links need to be amended to point to the correct repo.
Sign up for:
- CI Test system - e.g. GitHub Actions, Travis
- A Documentation website - e.g. ReadTheDocs
- Static Code Analysis tool - e.g. Codacy
- CII Best Practices https://bestpractices.coreinfrastructure.org
Only CII Best Practices (and its badge) is mandatory. Any equivalent public automated tools for the other three may be used.
Note that the CII Best Practices questionaire will request evidence of tooling used.
One or two sentence preamble describing the element
Background information and links to relevant terms
How to install the component
Information about how to install the <Name of component> can be found at the corresponding section of the
[Installation & Administration Guide](docs/installationguide.md).
A `Dockerfile` is also available for your use - further information can be found [here](docker/README.md)
How to use the component
Information about how to use the <Name of component> can be found in the [User & Programmers Manual](docs/usermanual.md).
The following features are listed as [deprecated](docs/deprecated.md).
Definition of the API interface:
Information about the API of the <Name of component> can be found in the [API documentation](docs/api.md).
How to test the component
For performing a basic end-to-end test, you have to follow the step below. A detailed description about how to run tests can be found [here].
> npm test
MIT ©