Contribution Guidelines

We welcome patches to the toolkit, as long as you follow these guidelines:

Indentation and whitespace

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

Versioning

We use Semantic Versioning.

Releasing a new version

  1. Create a branch that proposes a new version number and update the {CHANGELOG}. To see the commits to be summarised in the changelog since the last release, compare the latest-release branch with master.

  2. Open a Pull Request - here is a good example.

  3. Once merged into master a new version will be built and downstream jobs triggered by Travis CI for govuk_frontend_toolkit_gem and govuk_frontend_toolkit_npm.

Commit hygiene

Please see Alphagov git style guide which describes how we prefer git history and commit messages to read.