Manage Source Code

Team members are responsible for tracking and recording their work. This section describes practices that you are expected to follow in managing source code.

Design documents

You are not expected to produce design documents or diagrams for your features; details related to a particular task should be logged in the corresponding Git issues.

The exception to this guidelines are an ER diagram and class diagram that are explicitly listed as required. See track project artifacts for details.

Code comments

When writing code, you should add strategic code comments to explain the purpose of your code (not “what it does”, but “why is it done this way”). This does not need to be exhaustive, but it’s a good practice for complex and/or critical code.

If you use any external code (or code produced by GenerativeAI) then you are required to add a code comment inline, indicating the source of the code.