6.1 Development

govstack-cfr-development 2.0.0

#1 All application source code and comments are clear and maintainable, written in English. (REQUIRED EXTENSIBLE)

All application source code and comments are written clearly in English and structured for readability and maintainability. Code must follow a consistent style guide, naming conventions, and folder structure.

#2 EOL SHOULD be at Least 5 Years (RECOMMENDED REPLACEABLE)

No languages, frameworks, or dependencies should be used in a building block where that component has an EOL of less than 5 years.

#3 Include Unit and Integration Test Coverage (RECOMMENDED EXTENSIBLE)

Building block includes unit and integration tests to validate functionality and facilitate regression testing.

#4 Regular Security and Code Quality Audits Are Being Run (RECOMMENDED EXTENSIBLE)

Audits can be run across code and dependencies using automated tools such as SonarQube or Snyk.

#5 Preference for the top 25 languages listed in either the TIOBE Index or any of the three IEEE Spectrum rankings (RECOMMENDED REPLACEABLE)

See https://www.tiobe.com/tiobe-index/, https://spectrum.ieee.org/top-programming-languages

Where possible, building blocks SHOULD be written using commonly used languages to ensure ongoing maintenance and support are as easy as possible. Building blocks MAY leverage less common languages, such as shell scripting where needed.

#6 Follow Best Practices for Public Code (RECOMMENDED EXTENSIBLE)

See https://standard.publiccode.net/ and practices outlined here:

• Code in the Open

• Bundle Policy and Source Code

• Create Reusable and Portable Code

• Welcome Contributions

• Maintain Version Control

• Require Review of Contributions

• Document Your Objectives

• Document your code

• Use plain English

• Use open standards

• Use continuous integration

• Publish with an open license

• Use a coherent style

• Pay attention to codebase maturity

#7 All application source code uses version control (e.g. Git). Database schema changes are managed with migration scripts. (RECOMMENDED EXTENSIBLE)

All source code is version controlled (e.g., Git), and database schema changes are managed through migration scripts.

#8 All software developed is marked with a clear open-source license. (RECOMMENDED IMMUTABLE)

All software developed includes a clear open-source license.