Documentation

Documentation is good.

• This will help others understand what you are doing.
• This will help you think formally about what you are doing and come up with a better design.
• This will help your code stand the test of time and not get removed by an angry person not understanding what you did who is refactoring the code base two years later.

We expect the code base to be well documented with three types of documentation:

Doxygen Docs

Inline Documentation

Design Docs

• Go to our design doc repo
• Fork the repo and follow the instruction to write your design doc
• Submit a PR and assign reviewers. We want it to be a discussion!
• You can do this before you start writing your code or after. Doing this before allows you to get input from other people earlier, but you might need to come back and change things so they are up-to-date.
• When in doubt, just write it down. (whether you need a design doc, whether something needs to go into the design doc, etc. )