About the Foundation for Public Code

Naming files for

This guide

Contents

  1. Glossary
  2. Exceptions for naming conventions

All files in About have to be descriptive of their content.

Filenames are lowercase with dashes to separate words.

For example beer-pong.md, discos.md or file-to-solve-all-of-your-issues.md

Glossary

In the glossary files with definitions are named the term followed by -definition.md. For example ice-cream-definition.md or batmobile-definition.md

Exceptions for naming conventions

Filenames that are community standards such as README.md, CONTRIBUTING.md and LICENCE.md should follow the common conventions.