Standard for Public Code

目次

  1. Requirements
  2. Why this is important
  3. What this does not do
  4. How to test
  5. Policy makers: what you need to do
  6. Management: what you need to do
  7. Developers and designers: what you need to do
  8. Further reading

到 GitHub 貢獻

Use open standards

Requirements

  • For features of the codebase that facilitate the exchange of data the codebase MUST use an open standard that meets the Open Source Initiative Open Standard Requirements.
  • Any non-open standards used MUST be recorded clearly as such in the documentation.
  • Any standard chosen for use within the codebase MUST be listed in the documentation with a link to where it is available.
  • Any non-open standards chosen for use within the codebase MUST NOT hinder collaboration and reuse.
  • If no existing open standard is available, effort SHOULD be put into developing one.
  • Standards that are machine testable SHOULD be preferred over those that are not.

Why this is important

  • Creates interoperability between systems.
  • Reduces possible vendor lock-in.
  • Guarantees access to the knowledge required to reuse and contribute to the codebase.

What this does not do

  • Make it understandable how to use the software.

How to test

  • Confirm that data exchange follows an OSI approved open standard.
  • Confirm that any non-open standards used are clearly documented as such.
  • Confirm that documentation includes a list of the standards followed within the codebase, each with a working link, or a statement that no standards were chosen.

Policy makers: what you need to do

  • Mandate use of open standards everywhere possible.
  • Prohibit procurement of technology that does not use open standards.

Management: what you need to do

  • Consider including open standard compliance assessment in code reviews.

Developers and designers: what you need to do

  • Add continuous integration tests for compliance with the standards.
  • Review the commits and other repository resources for references to standards and cross-check those with the standards listed.

Further reading