When adding significant features, always remember to update relevant documentation.
- If you've added a feature, make sure it's mentioned in the README. The amount of space it takes up should be relevant to the
significance of the feature and the length and composition of the existing README - If you've finished a TODO or implementation task, update that document. Alternately keep a log/record next to it of what's been done, the tradeoffs made, and what's left to do
- ALWAYS document changes to how the application or utility is run, including CLI options (though not every minor option needs to be documented).
- ALWAYS document changes to how the application is deployed, in the sense of the specific steps or scripts that deploy it.
- Details on whether to include specific deployment environments and architecture in the README should be left to the user. They
can be added freely if they already exist there.