diff --git a/.agents/skills/quantmind-dev/SKILL.md b/.agents/skills/quantmind-dev/SKILL.md index 9e01dfc..50391fa 100644 --- a/.agents/skills/quantmind-dev/SKILL.md +++ b/.agents/skills/quantmind-dev/SKILL.md @@ -1,6 +1,6 @@ --- name: quantmind-dev -description: Contributor workflow for the QuantMind codebase. Covers commit format, pull request format, and component development across quantmind/ modules (knowledge, configs, preprocess, rag, flows, mind, utils) with tests, examples, and verification. Use when committing, opening a PR, or implementing/refactoring QuantMind code. +description: Contributor workflow for the QuantMind codebase. Covers contributor setup (environment + hooks), filing issues, commit format, pull request format, and component development across quantmind/ modules (knowledge, configs, preprocess, rag, flows, mind, utils) with tests, examples, and verification. Use when setting up as a contributor, filing an issue, committing, opening a PR, or implementing/refactoring QuantMind code. --- # QuantMind Dev @@ -24,6 +24,10 @@ Development workflow for contributing to the QuantMind codebase. ## Select Workflow +- Setting up as a contributor (environment, hooks, first verify) → + `references/setup.md` +- Filing an issue for a bug or a missing capability → + `references/setup.md` ("File an Issue" section) - Committing staged work → `references/commit.md` - Opening or updating a pull request → `references/pull-request.md` - Implementing or refactoring anything under `quantmind/` → diff --git a/.agents/skills/quantmind-dev/references/setup.md b/.agents/skills/quantmind-dev/references/setup.md new file mode 100644 index 0000000..e4130de --- /dev/null +++ b/.agents/skills/quantmind-dev/references/setup.md @@ -0,0 +1,69 @@ +# Contributor Setup and Issue Filing + +How to set a working copy up for contribution, and how to file an issue. +Human-readable equivalent: root `CONTRIBUTING.md` (same steps, same order). + +## Set Up as a Contributor + +1. Get a working copy. External contributors fork on GitHub and clone the + fork; maintainers branch directly off `master`: + + ```bash + git clone https://github.com//quant-mind.git && cd quant-mind + git checkout -b / # e.g. feat/sec-collection + ``` + +2. Create the environment with [uv](https://github.com/astral-sh/uv): + + ```bash + uv venv && source .venv/bin/activate + uv pip install -e ".[dev]" + ``` + +3. Install the git hooks (pre-commit lint/format stage plus the pre-push + verify stage): + + ```bash + ./scripts/pre-commit-setup.sh + ``` + +4. Confirm the checkout is green before changing anything: + + ```bash + bash scripts/verify.sh + ``` + + Verify is the single deterministic gate — format, lint, types, import + boundaries, tests with coverage. CI runs the exact same script, so a green + local run means a green PR. If it fails on a fresh checkout, stop and report + that instead of working around it. + +5. Continue with the workflow references: `develop-components.md` before + writing code, then `commit.md` and `pull-request.md`. + +## File an Issue + +1. Requires an authenticated GitHub CLI (`gh auth status`; if missing, ask the + user to run `gh auth login` themselves). +2. Pick the shape that matches the request: + - Defect in existing behavior → `.github/ISSUE_TEMPLATE/bug_report.md` + - Missing source, knowledge type, flow, or capability → + `.github/ISSUE_TEMPLATE/feature_request.md` +3. Write the body in English following `contexts/dev/github-writing.md` + (no hard-wrapping), and apply labels per `contexts/dev/labels.md`. +4. Search for duplicates first (`gh issue list --search ""`), then: + + ```bash + gh issue create --title "" --body-file \ + --label "