We're not ready for contributions yet, this document exists as a guide for those working on govuk-frontend.
- 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.
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 change, New feature, Fix or Internal.
Please include a description of the work done and a link to the PR (see current CHANGELOG for the format).
Include the modified CHANGELOG in the PR.
See tasks.
See deploying.
We are not using semantic versioning yet, we are going to talk about this soon.
See CHANGELOG for more information.
See publishing.