-
When using standard markdown use-cases capital letters should be used. e.g:
CHANGELOG.md
,README.md
,CONTRIB.md
,LICENSE
These should be placed in the root directory of your repo
Note LICENSE does not have a
.md
extension and should be plain text. -
To prevent cluttering the root namespace in repos, any "non-standard" documentation should be placed in a
docs
folder off the root. -
When using a "non-standard" name, camelcase filenames should be used e.g.
docs/myAdditionalDocumentation.md
.