Skip to content

Latest commit

 

History

History
executable file
·
39 lines (24 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
39 lines (24 loc) · 1.26 KB

Contribution guidelines

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.

GOV.UK Elements

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.

Raising bugs

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

Suggesting features

Please raise feature requests as issues before contributing any code. This is just to ensure they are discussed properly before any time is spent on them.

Contributing code

Indentation and whitespace

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

Versioning

We use semantic versioning, and bump the version on master only. Please don't submit your own proposed version numbers.

Commit hygiene

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