We really like contributions and bug reports, in fact the project wouldn't have got to this stage without them. We do have a few guidelines to bear in mind.
We have two Slack channels for the Prototype kit. You'll need a government email address to join them.
When raising bugs please explain the issue in good detail and provide a guide to how to replicate it. When describing the bug it's useful to follow the format:
- what you did
- what you expected to happen
- what happened
Please raise feature requests as issues before contributing any code.
This ensures they are discussed properly before any time is spent on them.
The project contains code taken from the GOV.UK Elements project. Please check that any issues related to that code are raised with that project, not this one.
Your JavaScript code should pass linting.
For anything else, maintain 2-space, soft-tabs only indentation. No trailing whitespace.
Follow the guidelines on semver.org for assigning version numbers.
Versions should only be changed in a commit of their own, in a pull request of their own. This alerts team members to the new version and allows for last-minute scrutiny before the new version is released. Also, by raising a separate pull request, we avoid version number conflicts between feature branches.
Please see our git style guide which describes how we prefer git history and commit messages to read.
Update CHANGELOG.md to summarise the changes made since the last release.
To see the commits to be summarised in the changelog since the last release, compare the latest-release branch with master.
Propose a new version number in VERSION.txt and update line 4 in package.json with the new version number.
Open a new pull request with a single commit including the above changes.
Here is an example for v6.1.0.
Once merged into master a new version will be built.