Justice On The Web
Table of contents

Justice On The Web

This site aims to document the team’s technical guidance and engineering practices.

Standards

Borrowing from Google’s engineering practices, our aim within JOTW, with respect to our standards, is to always “make sure that the overall code health …is improving over time … [and that] all of the tools and processes of code review are designed to this end”.

See Google’s full documentation on coding standards.

Monzo also puts forward a number of principles worth consideration.

Code Review

On this aspect, it seems Google has done an excellent job covering the dos and don’ts. For now we can reference their documentation, however, as a team we can discuss if there are areas in which we diverge from their documentation or are not applicable.

The Standard of Code Review

TL;DR - see their section on “Principles”.

Style guide

This covers a lot of ground. For now I’m again, going to be referencing Google’s documentation as a default where there are gaps but we can continue to update this section where we deviate from Google.

We currently do not have a team style guide for using Git, however, GDS provide a useful default for us to follow:

Testing our applications

Every website, component, or app that we build with a web interface, should be tested against a suite of different browsers and devices. This is to ensure we are meeting a minimum expected standard across government applications and provide a reasonable level of accessibility for all. We currently follow GDS specifications on what browsers to test on,

While this list meets the minimum requirements, individual sites may have a specific set of requirements based on user testing and research data, that should also be taken into consideration.

Assistive technology testing (AT)

We want everyone to be able to access the content within our websites. This means taking into account users who require assistive technologies and understand how they access our web content. This can only be achieved by testing our websites against AT. GDS offer guidance around what ATs we should be using,

As a team, we are currently working out the best ways to incorporate the above GDS guidance into our testing process.

Interesting further reading on the viewpoint of AT users, can be found at Responses to the screen reader strategy review (External site)

Runbooks

Runbooks have now moved to Justice On The Web Online Content Flight Rules along with details proceedures for empergency situations.

Many runbooks are still currently located in Confluence . TODO: Review and migrate runbooks over those still useful.

How to guides

Tools

Devs in the team use a wide selection of tools. Some are critical to the development of our apps and are required. Below are a listing of these critical and the “nice to haves’”.

Required

Nice to haves

Editors

Testing

Learning

Continuous learning is really important us. To aid in this, we have resources available. Ask around in the team for access, however, some resources may require contacting the service desk for access. Here are some recommended learning resources.