6.4 Quality

govstack-cfr-quality 2.0.0

#1 Documentation must be Provided (REQUIRED EXTENSIBLE) (previously 5.5)

Documentation on the installation and use of the Building Block MUST be provided. Where possible, this documentation SHOULD be stored alongside code in a repository. Documentation MAY be generated from code where applicable.

#2 Web user interfaces comply with HTML5 and CSS3 standards. (REQUIRED EXTENSIBLE)

All web UIs comply with HTML5 and CSS3 standards and follows modern responsive design and accessibility best practices.

#3 Provide an OpenAPI specification (RECOMMENDED EXTENSIBLE) (previously 5.6)

Each building block’s service APIs MUST be defined and exposed using a standardized machine-readable language. External APIs are described using the OpenAPI 3.x specification. See the following resources for additional information:

• Definition of the OpenAPI standard

• Swagger OpenAPI 3.0 Specification

#4 Provide a Compliance Test Mock/Example Implementation (RECOMMENDED REPLACEABLE) (previously 5.26)

A building block MAY provide a mock testing implementation of API functionality to show example endpoints and data payloads. See https://github.com/GovStackWorkingGroup/bb-template/tree/main/examples for additional information.

#5 Building blocks should be Localizable (RECOMMENDED EXTENSIBLE) (previously 5.27)

Where a building block has a human user interaction, it SHOULD be able to present information to the user in their local language. Building blocks should be designed to support multiple locales.

#6 The functional scope of the system is defined and documented in clear business use cases and user stories. (RECOMMENDED EXTENSIBLE)

Functional scope is clearly documented using business use cases and user stories. Ensures consistent understanding and testing of system capabilities.

#7 All end-user functionality is covered by automated functional tests, including both UI and API interactions. (RECOMMENDED EXTENSIBLE)

All end-user functionality MUST be covered by automated functional tests. Includes UI tests, API tests, and integration tests. Supports continuous integration (CI) pipelines and regression safety.

#8 Applications meet the accessibility requirements of WCAG 2.1 at the AA level. (RECOMMENDED IMMUTABLE)

Applications meet WCAG 2.1 AA accessibility requirements. Ensures usability for people with disabilities and compliance with legal/regulatory standards.