We love contributions! We've compiled these docs to help you understand our contribution guidelines. If you still have questions, please contact us, we'd be super happy to help.
- Code of conduct
- Application architecture
- Running locally
- Conventions to follow
- Testing and linting
- Supported browsers
- Commit hygiene
- Updating Changelog
Please read CODE_OF_CONDUCT.md before contributing.
See application architecture for an overview of the directories in this repository.
See running locally.
2-space, soft-tabs only. No trailing whitespace.
See our coding standards for CSS and testing and linting.
See our coding standards for JavaScript and testing and linting.
See our coding standards for components, coding standards for Nunjucks macros and testing and linting.
See testing and linting.
Your contribution needs to work with certain browsers as set out in README. See also supporting Internet Explorer 8.
Your contribution needs to work with certain assistive technology as set out in README.
Please see our git style guide which describes how we prefer git history and commit messages to read.
If you open a GitHub pull request on this repo, please update CHANGELOG to reflect your contribution.
Add your entry under Unreleased as Breaking changes, New features, Fixes.
Internal changes to the project that are not part of the public API do not need changelog entries, for example fixing the CI build server.
These sections follow semantic versioning, where:
Breaking changescorresponds to amajor(1.X.X) change.New featurescorresponds to aminor(X.1.X) change.Fixescorresponds to apatch(X.X.1) change.
See the CHANGELOG_TEMPLATE.md for an example for how this looks.
Include the modified CHANGELOG in the PR.
See tasks.
See deploying.
See publishing.