Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (33 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 2.22 KB

Contribution guidelines

We love contributions! We've compiled these docs to help you understand our contribution guidelines.

Contents of this file

For contributors

Code of Conduct

Please read the alphagov CODE_OF_CONDUCT.md before contributing.

Conventions to follow

Indentation and whitespace

2-space, soft-tabs only. No trailing whitespace. The repository contains an .editorconfig file to enforce this if your editor supports this.

Coding style

We follow the style conventions detailed in the GDS Way.

Supported browsers

While the project is in beta, we're using the Service Manual's browsers to test in. We will reassess this at some point before our next service assessment based on usage data.

Supported assistive technology

While the project is in beta, we're using the Service Manual's assistive technologies to test with. We will reassess this at some point before our next service assessment based on usage data.

Supported email clients

For our SES emails, any changes to the markup should be tested in the following email clients:

Desktop clients

  • Microsoft Outlook
  • Microsoft Outlook (Classic)

Web clients

  • Microsoft Outlook for the Web
  • Gmail

Small visual differences are acceptable, but it's important that the submission data in the email is visible and consistent regardless of client.

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.