A Jest preset for testing code within the Galaxy.
npm install --save-dev @theholocron/jest-preset"In your project package.json add the following:
{
"jest": {
"preset": "@theholocron/jest-preset"
}
}Currently we use Jest for our testing framework. There isn't much to our configuration that differs from what Jest provides out of the box with the following exceptions:
- Coverage: we enforce coverage collection and require that all work be covered at least 80% at this time. If the library has increased above that standard, then it is expected to override the configuration and maintain the higher level of standards. However, it is not allowed to lower the standard.
- Directory Naming: while we do support the same regex that Jest provides, our convention is to name the test directory as
test. In the event the library is simple, the directory should be on the same level as thesrccode; in the event of a more complex scenario, then it is okay to place the directory in within the same level as the code being tested.
This project uses a CHANGELOG and GitHub releases which contains a curated, chronologically ordered list of notable changes for each version of a project. Read more about changelogs.
We use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes.
- MINOR version when you add functionality in a backward-compatible manner.
- PATCH version when you make backward-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
Have a bug or a feature request? Looking to contribute to advance the project? Read our contribution guide or maintenance guide first in order to understand how we do things around here. Or you could look at some of our other guides below:
How do I… (click to expand)
Looking to talk to someone or need some help? Please read our support guidelines.
©2020 GNU General Public License v3. See LICENSE for specifics.