CONTRIBUTING.md

Contribution guidelines

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.

Contents of this file

For contributors

• Code of conduct
• Application architecture
• Running locally
• Conventions to follow
  • Indentation and whitespace
  • CSS
  • JavaScript
  • Components and Nunjucks API
• Testing and linting
• Supported browsers
• Commit hygiene
• Updating Changelog
• Testing a release

For maintainers

• Application tasks
• Deploying
• Versioning
• Releasing a new version

Code of Conduct

Please read the alphagov CODE_OF_CONDUCT.md before contributing.

Application architecture

See application architecture for an overview of the directories in this repository.

Running locally

See running locally.

Conventions to follow

Indentation and whitespace

2-space, soft-tabs only. No trailing whitespace.

CSS

See our coding standards for CSS and testing.

JavaScript

See our coding standards for JavaScript and testing .

Components and Nunjucks API

See our coding standards for components, coding standards for Nunjucks macros and testing.

Testing and linting

See testing.

Supported browsers and assistive technology

Your contribution needs to work with certain browsers and assistive technology as set out in README.

Commit hygiene

Please see our Git style guide in the 'How to store source code' page of the GDS Way, which describes how we prefer Git history and commit messages to read.

Updating Changelog

See the versioning documentation for updating the changelog

Testing a release

If you need to test a release, for example if you're contributing a new component see Publishing a preview of GOV.UK Frontend.

Application tasks

See tasks.

Deploying

See deploying.

Releasing a new version

See publishing.