Verify documentation keeps up with a code change in dynamic-neural-field-composer - Doxygen on public API, the matching wiki page, and stale references elsewhere. Use before opening a PR, or when asked whether docs need updating.
中文简介正在准备中。当前显示原文说明。
查看安装方法安装前可以查看交给 AI 代理的指令内容。
Three passes over git diff origin/main...HEAD. Report findings; do not silently rewrite
prose that is merely different from how you would put it.
Scope: new or changed public entities under dynamic-neural-field-composer/include/.
Each needs:
@brief - one line, what it does@param per parameter, names matching the signature exactly@return unless the return type is voidFlag three failure modes:
Private helpers in src/ do not need Doxygen.
dynamic-neural-field-composer/wiki/ has 15 pages. Map the change to its page:
| Changed | Page |
|---|---|
| Element behaviour, new element type | Elements.md, Element Reference.md |
| Element parameters, tuning defaults | Element Reference.md, Parameter Tuning Guide.md |
| GUI, windows, node editor | Application and UI.md |
| Simulation loop, timing, recorder | Simulation.md |
| Plots, heatmaps, visualization | Visualization.md |
| Build, dependencies, setup | Getting Started.md, Troubleshooting.md |
| Public API shape, architecture | Architecture.md, How to Add New Elements.md |
| New example executable | Examples.md, How to Create and Run Your Own Example Executable.md |
| Test infrastructure | Testing.md |
Rule of thumb: if a user could notice the change without reading the source, a wiki page owes them an explanation. Pure internal refactors do not.
Grep the repo for references the change invalidated:
grep -rn "<old_symbol>" README.md CONTRIBUTING.md CHANGELOG.md dynamic-neural-field-composer/wiki/ .claude/
Look for renamed or removed symbols, moved file paths, changed build commands or flags,
and example snippets that no longer compile. Check README.md and CONTRIBUTING.md
specifically when the build process or directory layout moved.
For each pass: either "clean" or a concrete list of file + line + what is wrong. If nothing in the diff touches public API or user-visible behaviour, say so and stop - a refactor with no API change legitimately needs no doc update.
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Orchestrate unattended resolution of open GitHub issues - triage by complexity, dispatch parallel worker agents into isolated worktrees, review their diffs, open PRs, and monitor CI and CodeRabbit until green. Use when asked to work through open issues autonomously or put Claude on auto-pilot.
中文简介正在准备中。当前显示原文说明。
Configure, build and test dynamic-neural-field-composer. Use whenever you need to compile the library, run the GoogleTest suite, verify a change builds, or reproduce a test failure.
中文简介正在准备中。当前显示原文说明。
Read the uncommitted diff in dynamic-neural-field-composer and print conventional commit message(s) for it, grouped by logical change. Use when asked to write, suggest or draft a commit message, or "what should I commit this as".
中文简介正在准备中。当前显示原文说明。
Check a change for performance regression against this machine's recorded baseline - decide whether the diff needs checking, run the deck benchmark under the hygiene wrapper, and attribute any regression to an element. Use before opening a PR that touches the simulation hot path.
中文简介正在准备中。当前显示原文说明。
Read the branch diff in dynamic-neural-field-composer and print a PR title and description in chat, filling the repo's pull request template. Use when asked to write, draft or suggest a PR title/description, or "what should the PR say".
中文简介正在准备中。当前显示原文说明。
Review a diff against dynamic-neural-field-composer's own standards - backwards compatibility, Clean Code, tools/ helper reuse, C++20 idiom, hot-path performance, and test coverage. Use before opening a PR or when asked to review a branch or change.
中文简介正在准备中。当前显示原文说明。