mirror of
https://github.com/Kpa-clawbot/meshcore-analyzer.git
synced 2026-08-01 03:39:25 +00:00
docs: add AGENTS.md rule 12 — PR review follow-up comments (#301)
Adds rule 12 to AGENTS.md: when review feedback is addressed, post a follow-up comment on the PR listing what was fixed with the commit hash. Co-authored-by: Kpa-clawbot <259247574+Kpa-clawbot@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
co-authored by
Kpa-clawbot
Copilot
parent
7155b5b017
commit
380da0ee0b
@@ -94,6 +94,9 @@ The packets page loads 30K+ packets. Don't add per-packet API calls. Don't add O
|
||||
### 11. PR descriptions must be clean markdown
|
||||
When opening a pull request, the description must be **valid, readable markdown**. Use real newlines (not `\n` literals), proper code fences, and correct heading syntax. Write it using `--body-file -` (piped from a heredoc or file), never inline `--body` with escaped characters. If the description renders as garbage, fix it before requesting review. This is the first thing reviewers see.
|
||||
|
||||
### 12. Post a follow-up comment when review feedback is addressed
|
||||
When you push fixes for review comments, post a comment on the PR listing what was changed and the commit hash. Reviewers should not have to dig through commits to find what was fixed. Format: "Review feedback addressed (commit `abc1234`)" followed by a numbered list of what was done.
|
||||
|
||||
## MeshCore Firmware — Source of Truth
|
||||
|
||||
The MeshCore firmware source is cloned at `firmware/` (gitignored — not part of this repo). This is THE authoritative reference for anything related to the protocol, packet format, device behavior, advert structure, flags, hash sizes, route types, or how repeaters/companions/rooms/sensors behave.
|
||||
|
||||
Reference in New Issue
Block a user