docs: clarify development constraints and error contracts#437
Open
AkashiSensei wants to merge 1 commit into
Open
docs: clarify development constraints and error contracts#437AkashiSensei wants to merge 1 commit into
AkashiSensei wants to merge 1 commit into
Conversation
- refine contributor docs for backend, frontend, CLI, website, and shared development workflow - document API error contract references, actionable backend messages, and frontend/CLI error presentation expectations - centralize CLI command, admin namespace, skill separation, and error-context rules in SPEC and related skills Refs raids-lab#416 Signed-off-by: AkashiSensei <fengzhiyuyi2013@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify Crater development constraints and error-contract documentation across backend, frontend, CLI, website, and development Skills.
Changes
bizerr/resputil.HandleErrorexpectations, point contributors to live definition files such asbackend/internal/bizerr/groups.go,backend/internal/resputil/handle.go, andbackend/internal/resputil/response.go, and keep concrete codes as examples rather than copied tables.msg, HTTP status, and business-code facts while allowing frontend/CLI-specific presentation where needed.cli/docs/SPEC.md,cli/docs/REVIEW.md, CLI Skill templates, and shared CLI Skills.crater-devel-*Skills so future Agents route code/docs/review work consistently and prompt developers for the required manual checks.Testing
AI:
git diff --check: passedgit commit -s: passed repository pre-commit hook, including Website, Frontend, and Backend checksdiff -qbetween repositorycrater-devel-*Skills and locally installed~/.agents/skills/crater-devel-*: matched after local syncdocs/issue-416-dev-constraintsis1 ahead / 0 behindrelative toorigin/mainDeveloper:
Other
澄清 Crater 后端、前端、CLI、website 与开发 Skills 中的开发约束和错误返回契约。
修改
bizerr/resputil.HandleError的使用期望,指向backend/internal/bizerr/groups.go、backend/internal/resputil/handle.go、backend/internal/resputil/response.go等实时定义文件,并要求具体 code 只作为示例而不是复制成长表。msg、HTTP 状态和业务码等排查事实,同时允许前端 / CLI 在需要时做本地化或领域化展示。cli/docs/SPEC.md、cli/docs/REVIEW.md、CLI Skill 模板和 shared Skill 中。crater-devel-*Skills,让后续 Agent 在代码、文档和 review 任务中按同一套规则路由,并提示开发者完成必要人工检查。测试
AI:
git diff --check:通过git commit -s:通过仓库 pre-commit hook,包括 Website、Frontend 和 Backend checksdiff -q对比仓库内crater-devel-*Skills 与本地安装的~/.agents/skills/crater-devel-*:本地同步后一致docs/issue-416-dev-constraints相对origin/main为1 ahead / 0 behind开发者:
其他
Resolve #416