mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-08-14 13:55:55 -07:00
32 lines
1.0 KiB
Markdown
32 lines
1.0 KiB
Markdown
<!-- read_when: starting implementation, deciding whether to plan, or checking handoff expectations -->
|
|
|
|
# Workflow
|
|
|
|
Status: active
|
|
Last verified: 2026-08-13
|
|
Owner: Kyle Yasuda
|
|
Read when: planning or executing nontrivial work in this repo
|
|
|
|
This section is the internal workflow map for contributors and agents.
|
|
|
|
## Read Next
|
|
|
|
- [Planning](./planning.md) - when to write a lightweight plan vs a full execution plan
|
|
- [Verification](./verification.md) - maintained test/build lanes and handoff gate
|
|
- [Agent Skills](./agent-skills.md) - repo-local workflow skill ownership
|
|
- [Release Guide](../RELEASING.md) - tagged release workflow
|
|
|
|
## Default Flow
|
|
|
|
1. Read the smallest relevant docs from `docs/`.
|
|
2. Decide whether the work needs a written plan.
|
|
3. Implement in small, reviewable edits.
|
|
4. Run the cheapest sufficient verification lane.
|
|
5. Escalate to the full maintained gate before handoff when the change is substantial.
|
|
|
|
## Boundaries
|
|
|
|
- Internal process lives in `docs/`.
|
|
- Public/product docs live in `docs-site/`.
|
|
- Generated artifacts are never edited by hand.
|