Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 1.48 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.

Community

We have a Slack channel for the HMRC Prototype kit. You'll need an HMRC email address to join it.

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 ensures 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

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.

Commit hygiene

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