Guidelines for breaking down a backlog task into smaller tasks - theolind/mahm3lib GitHub Wiki

Please contribute with "rules" about when to do the first/initial commits to GitHub.

Most tasks that involve writing device drivers can be divided into these tasks:

1. Define API

To be able to define an API you must study the microcontroller's datasheet. In the datasheet you'll get information about:

  • features of the device
  • what registers to use
  • possible dependencies of other devices/units
  • etc....

Upload header file (with API definition) to GitHub!

2. Review API

When you've defined a suggestion of the API, it's time to discuss this matter with the Architect.
Important! The API must be reviewed by the Architect 7 days before the Sprint Demo.

3. Document first draft of API

Generate Doxygen documentation.

4. Upload header file (with API definition) to GitHub
5. Define unit tests

For automatic tests, write tests based upon information on registers and the API.
Manual tests should be documented.

6. Write code

Write code until all test cases are satisfied.

7. Update API documentation

Generate Doxygen documentation (and perhaps other things that are good to know).

8. Integrate the code

When the code is working as specified, then it's time to integrate the code into the rest of the project.

⚠️ **GitHub.com Fallback** ⚠️