Skip to content

chore(dev): add quantmind-dev skill and align contributor instructions#94

Merged
keli-wen merged 1 commit into
masterfrom
feat/quantmind-dev-skill
Jul 10, 2026
Merged

chore(dev): add quantmind-dev skill and align contributor instructions#94
keli-wen merged 1 commit into
masterfrom
feat/quantmind-dev-skill

Conversation

@keli-wen

Copy link
Copy Markdown
Contributor

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 the quantmind-dev skill. 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-dev skill: 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 to scripts/verify.sh and the canonical workflow.

No runtime code, CLI, configuration schema, or dependency introduced.

Verification: bash scripts/verify.sh green — all 5 steps pass (ruff format, ruff check, basedpyright, lint-imports, pytest: 233 passed, 89.48% branch coverage). Skill mirrors verified byte-identical with diff -r.

Checklist

  • The PR title starts with $CATEGORY(xx): xxx
  • Related issue is referred in this PR
  • The markdown and latex are rendered correctly.
  • The code in PR is well-documented.
  • The PR is complete and small, read the Google eng practice (CL equals to PR) to understand more about small PR.

🤖 Generated with Claude Code

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>
@keli-wen keli-wen added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 10, 2026
@keli-wen keli-wen self-assigned this Jul 10, 2026
@keli-wen keli-wen merged commit 26c278c into master Jul 10, 2026
2 checks passed
@keli-wen keli-wen deleted the feat/quantmind-dev-skill branch July 10, 2026 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: add contributor instructions and quantmind-dev skills

1 participant