Synthetic Philosophy and Deductive Engineering
When you are assigned a code or test task, please follow these steps to ensure a smooth and efficient completion:
Create a new branch from the main branch of the repository.
Understand the Requirements: Carefully read the assignment details to fully understand what is expected. If anything is unclear, reach out to the assigner for clarification. These should include detailed design documents, and description of the module test method. In creating documents for the assignment, please follow the documentation standards outlined in Project Structure and Documentation Policy amms001.md.
The task description should include:
- The subsystem to which the code or test belongs. (top level sub-directory)
- The filenames for the specifications, including the module test design document.
- The filenames for the code or test files to be created or modified.
- The filenames for the makefile for the module tests.
If there are any problems with the requirements, the first draft pull request should include a review document that outlines the issues (see document standards for review documents naming and placement)