chore(dev): add quantmind-dev skill and align contributor instructions#94
Merged
Conversation
Add a contributor-focused instruction layer for coding agents: - Rewrite AGENTS.md and CLAUDE.md as thin, aligned entry points: module map, canonical setup/verify commands, stable architecture constraints, test/example requirements, communication conventions, and routing to the quantmind-dev skill. - Add the quantmind-dev skill (mirrored under .agents/skills/ and .claude/skills/, identical copies) with three workflow references: commit format, pull-request format, and component development (dependency contracts, per-module guidance, tests, examples, verification). - Refresh CONTRIBUTING.md: remove stale pre-migration content (removed modules, deleted scripts, CLI tips, ABC-based patterns) and point to the canonical workflow. No runtime code, CLI, configuration schema, or dependency introduced. bash scripts/verify.sh green (233 tests, 89% branch coverage). Refs #93 Co-Authored-By: Claude Fable 5 <noreply@anthropic.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.
Description
Adds a contributor-focused instruction layer for coding agents working on the QuantMind codebase. Closes #93.
AGENTS.md/CLAUDE.md: rewritten as thin, aligned entry points — module map with dependency roles, canonical setup/verify commands, stable architecture constraints, test/example requirements, communication conventions, and routing to thequantmind-devskill. Migration-state tables and PR-by-PR roadmap removed (temporary repository state; history lives in git log and Tracking: Migrate Agent layer to OpenAI Agents SDK #71).quantmind-devskill: mirrored identically under.agents/skills/and.claude/skills/with progressive disclosure (SKILL.md routes; only the matching reference loads):references/commit.md— English Conventional Commits, meaningful scopes matching repo history, one logical change per commit, inspect staged diff first, never bypass hooks without explicit authorization.references/pull-request.md— small focused PRs, Conventional Commit titles, English bodies, issue references, verification statement, post-merge branch hygiene.references/develop-components.md— general development loop (find the nearest existing pattern first), import-linter dependency contracts as a who-may-import-whom table, per-module guidance (knowledge/configs/preprocess/flows/mind/utils), unit-test and example requirements, verification steps.CONTRIBUTING.md: stale pre-migration content removed (deleted modules, removed scripts, CLI tips, ABC-based patterns); now points toscripts/verify.shand the canonical workflow.No runtime code, CLI, configuration schema, or dependency introduced.
Verification:
bash scripts/verify.shgreen — all 5 steps pass (ruff format, ruff check, basedpyright, lint-imports, pytest: 233 passed, 89.48% branch coverage). Skill mirrors verified byte-identical withdiff -r.Checklist
$CATEGORY(xx): xxx🤖 Generated with Claude Code