firmware-base/lib/polymech-base/scripts/bugs.md

599 B

Context

  • ESP-32, Platform.io, C17

Create a brief report for potential bugs, leaks or race coditions, in ./docs/issues/profiles/[filename].md

Ignore: enums.h, Components.h, config.h

Ignore kind of issues : null pointer checks, thread safety, uninitialized pins, and any other overkill checks:)

Layout / Content :

File Name

Path : relative path (markdown link)

Issues Summary

Table of issues : severity, function, quick solution

Issues

Name of the issue

  • location of function code

the code

Potential solutions

...code