Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 725 Bytes

about-file-names.md

File metadata and controls

22 lines (14 loc) · 725 Bytes
type
Guide

Naming files for about.publiccode.net

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.