this is not effective, just a draft.
This document uses common key words to specify requirement levels
- companion scripts
- integration
- convenience
- Source files MUST have accompanying documentation and tests
New code SHOULD be integrated deep into the rest of the repository.
All changes effect current, existing and future solutions.
All code SHOULD follow the jsdocs specifications.
Dependencies SHOULD be noted, as such. Dependents additionally MAY be referenced.
If you know of a better way to do something, please provide the solution.
Quick and dirty tasks are welcome, as long as thorough documentation is provided, so that it can be later understood and enhanced.
Lint MUST succeed; feel free to change lint rules as long as they are reasonable and there are no errors.
Tests MUST pass; fix the code, not the tests.
Each documentation file...
MUST have a description which MAY be brief MUST have at least one example SHOULD have an explanations MAY link to theory or additional information thus so desired.
MUST assert every point of entry SHOULD verify reasonable input/output MUST NOT