pr-analysis
GitHub指导如何分析和响应GitHub PR中的代码审查意见。强调在修复重复问题时更新相关Skill,遵循代码风格规范(如逻辑清晰),严格执行测试代码编写检查清单,并在行动前加载code-standards、testing-workflow等前置Skill以确保合规性。
Trigger Scenarios
Install
npx skills add netalertx/NetAlertX --skill pr-analysis -g -y
SKILL.md
Frontmatter
{
"name": "pr-analysis",
"description": "How to analyze and respond to GitHub PR review comments in NetAlertX. Use this whenever you are addressing PR feedback, review threads, or inline code comments."
}
PR Analysis
Standing Rule: A Repeated Comment Becomes a Skill Update
If a review comment corrects something a skill should already cover, don't just fix that one instance — update the relevant skill as part of addressing the comment, same PR, same turn. If no skill covers it yet, that's the signal to create one. Check the skill first, though — sometimes it already covers the point and just wasn't consulted; the fix is in applying it, not in the skill being incomplete.
Code Style
- Prefer explicit, readable logic over compact-but-opaque expressions. When a built-in/clever expression (e.g. a
max()-based one-liner) saves a line or two but a reader has to reverse-engineer why it produces the right answer, write it out as plain conditional logic instead.
Before Writing Any Test Code — Non-Negotiable Checklist
Run through this before creating or editing any file under test/:
- Helpers first: Check
test/db_test_helpers.pyfor existing factories (make_db,make_device_dict,insert_device_from_dict,DummyDB). Use them. If what you need doesn't exist, add it there — never define it locally in the test file. - MAC literals must be lowercase: Every MAC string in fixtures, parametrize, assertions, docstrings, and comments must be lowercase hex (e.g.
aa:bb:cc:dd:ee:01). No exceptions. - Test file location: Place new tests under a subdirectory of
test/that mirrors the source path (e.g.test/scan/forserver/scan/). Don't add new files directly intest/root - a handful of existing ones there (e.g.test_plugin_helper.py,test_wol_validation.py) predate this convention; that's not license to add more, but don't migrate them unprompted either. - No inline imports: All imports at the top of the file.
Before Acting on Any PR Comment
- Load
code-standardsskill — all code changes must comply with it before replying. - Load
testing-workflowskill — any test additions or changes must follow it. - Load any domain-specific skill relevant to the files being changed (e.g.
database-patternsfor DB writes,settingsfor config).
Verifying a Claim About Generated Code
A finding that claims a specific SQL/code expansion result (an alias collision, a macro substitution, an interpolation outcome) can't be verified by checking the caller's own internal consistency alone - the caller can be perfectly self-consistent and still collide with something the callee does internally that isn't visible at the call site. Open and read the callee's actual definition before accepting or rejecting the claim, and if it's a runtime-behavior claim (not just syntax), run a minimal repro to confirm rather than reasoning about it in the abstract. A real case: a finding claimed two same-named aliases collided across a caller/helper boundary; checking only that the caller used its alias consistently looked like it disproved the finding, but the helper had its own same-named internal alias that was never inspected - the finding was correct.
Comment Classification
For each comment, determine:
| Type | Action |
|---|---|
| Request for code change | Make the change, validate it, then reply with the short commit hash |
| Question about code | Reply with a concise answer (no restatement of the question) |
| Suggestion / feedback | Decide if it is actionable. If yes, act and reply. If not, do not reply. |
| General / praise | Do not reply. |
Acting on Comments — Step by Step
- Identify all actionable comments before touching any file.
- Load relevant skills to understand conventions that apply.
- Prepare a plan — list each file and the exact change required. If a comment calls for new logic (a new check, helper, or condition), search for an existing equivalent first - the whole file being edited, not just the section in question, plus sibling pages/the Python backend - and extract/reuse it rather than planning a parallel implementation (see
code-standards' DRY Principle section). - Make changes one comment at a time — keep commits focused. For a comment claiming a bug: write the test that should catch it first, run it against the current (unfixed) code, and confirm it fails for the right reason before writing the fix - see
prd-writing's test-first step for why (a test that never failed red can't be trusted to have caught anything). - Rerun tests after each change (
testing-workflowskill) - confirm the new/updated test now passes, not just that nothing else broke. - Reply only after the commit is pushed. Include the short SHA.
Reply Guidelines
- Be concise. Do not summarize or restate the original comment.
- State what was done and (optionally) why.
- Include the short commit hash when relevant.
- Do not thank or compliment the reviewer.
What to Check After Every Batch of Changes
- MAC literals lowercase — grep for uppercase hex in every changed test file:
grep -Pn '[0-9A-F]{2}:[0-9A-F]' test/must be empty. - No local DB helpers — no
DummyDB,make_db, or inline DDL defined outsidetest/db_test_helpers.py. - No inline imports — all imports at the top of the file.
- Tests live under a subdirectory of
test/matching the source path, not intest/root. - Secret scan (
runtime-tools-secret_scanning) before committing.
Stacked / Base-Branch Issues
When a PR targets a non-default branch (e.g. next_release):
- Do not retarget the branch yourself; note it in a reply so the author can do it from the GitHub UI.
- Check CI failures on the base branch first before checking your branch.
Version History
- fe29f5d Current 2026-10-19 05:51
-
cd1d0ed
2026-09-22 11:07
新增代码风格指南(优先使用显式可读逻辑);新增重复评论触发 Skill 更新规则;新增执行步骤中关于识别所有可操作评论的要求。
-
a686a01
2026-09-03 06:46
细化测试文件位置规则,明确仅在test/子目录镜像源码路径放置新测试,禁止直接放于根目录;新增批量变更后检查项,包括MAC大写校验、本地DB helper检查及秘密扫描。
- 716a41a 2026-08-27 19:50


