You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
19 lines
768 B
19 lines
768 B
---
|
|
globs: *.md
|
|
alwaysApply: false
|
|
---
|
|
|
|
INITIAL_PLAN.md is unique to projects built inhouse and must never be deleted.
|
|
Maintain traditional files (README, CHANGELOG, BUILDING, etc.)
|
|
Any ad hoc files must always be put into docs folder
|
|
The docs folder must use sub-folders to classify documents by
|
|
There must never be more than seven folders at any sub-folder of the docs tree
|
|
Keep documents no more than seven in number for a folder.
|
|
If you need more documents than seven, make sub-folders to classify or re-classify documents.
|
|
Re-use documents by ammending or editing but always version them in git.
|
|
put documentation at the file, classs, and method heads
|
|
|
|
Documents themselves must:
|
|
|
|
Headings should be surrounded by blank lines
|
|
Lists should be surrounded by blank
|