Implementation guide for the Standard for Public Code

Make the codebase findable This criterion in the Standard for Public Code

Requirements

The name of the codebase SHOULD be descriptive and free from acronyms, abbreviations, puns or organizational branding.

Examples

The codebase SHOULD have a short description that helps someone understand what the codebase is for or what it does.

Maintainers SHOULD submit the codebase to relevant software catalogs.

Catalogs to consider:

The codebase SHOULD have a website which describes the problem the codebase solves using the preferred jargon of different potential users of the codebase (including technologists, policy experts and managers).

The codebase SHOULD be findable using a search engine by codebase name.

The codebase SHOULD be findable using a search engine by description of the problem it solves in natural language.

The codebase SHOULD have a unique and persistent identifier where the entry mentions the major contributors, repository location and website.

Tools

  • Wikidata - by creating an “item” an identifier is generated. Make sure to add references so that the information can be verified.
  • FSF software directory listing - by submitting a new entry an identifier is generated.

The codebase SHOULD include a machine-readable metadata description, for example in a publiccode.yml file.

Tools

Examples

A dedicated domain name for the codebase is OPTIONAL.

Regular presentations at conferences by the community are OPTIONAL.