feat: add requirements and technical baseline
This commit is contained in:
@@ -44,6 +44,22 @@ Do not silently choose one requirement over another.
|
||||
- Do not mark a milestone `COMPLETE` without concrete recorded evidence for
|
||||
every acceptance criterion.
|
||||
|
||||
### Commit message handoff
|
||||
|
||||
- After completing every user prompt, provide a proposed commit message for
|
||||
the resulting changes. This is mandatory when completing a milestone.
|
||||
- Use the Conventional Commits format `type(scope): imperative summary`, or
|
||||
`type: imperative summary` when no meaningful scope exists.
|
||||
- Choose exactly one appropriate type from `feat`, `fix`, `refactor`, `perf`,
|
||||
`test`, `docs`, `style`, `build`, `ci`, `chore`, or `revert`.
|
||||
- Write the commit message in English, use an imperative summary beginning
|
||||
with a lowercase verb, keep the subject at 72 characters or fewer when
|
||||
practical, and do not end it with a period.
|
||||
- Base the message on the actual completed changes and milestone outcome; do
|
||||
not use vague summaries such as `update files` or `make changes`.
|
||||
- Present the proposed commit message in the final response, but do not create
|
||||
the Git commit unless the user explicitly requests it.
|
||||
|
||||
### Locked platform baseline
|
||||
|
||||
- Target ESP32-C6FH4 with 4 MB Flash.
|
||||
@@ -65,6 +81,16 @@ Do not silently choose one requirement over another.
|
||||
- Active game state need not survive reboot; Wi-Fi configuration must persist
|
||||
in NVS.
|
||||
|
||||
### Code style
|
||||
|
||||
- Follow the repository `.clang-format`.
|
||||
- Format all modified C and C++ files with `clang-format`.
|
||||
- Prefer simple, explicit code that is easy for beginners to read.
|
||||
- Avoid clever one-liners and unnecessary abstractions.
|
||||
- Use braces for all non-trivial control-flow blocks.
|
||||
- Prefer descriptive variable and function names.
|
||||
- Keep functions reasonably small.
|
||||
|
||||
### Build and verification
|
||||
|
||||
- Parse the project configuration with
|
||||
@@ -78,4 +104,3 @@ Do not silently choose one requirement over another.
|
||||
- Test on the physical board before recording hardware acceptance evidence.
|
||||
- Preserve exact commands and relevant outputs in the active milestone's
|
||||
evidence section.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user