project-context
Read, write and extend docs/agents/project-context.md, the 150-line binding rules file executor agents load before code. Use with $orc-context.
- License 许可
- MIT
- 所属仓库
- HigorAlves/orc
- 最近更新
- 2026-11-07
- Stars
- ★ 7
- Forks
- 0
01 前言 Front Matter
- name
- project-context
- description
- Read, write and extend docs/agents/project-context.md, the 150-line binding rules file executor agents load before code. Use with $orc-context.
02 资源文件 1
- 参考文档references/FORMAT.md1.8 KB
03 SKILL.md 正文
Project Context
.orc/ dies at cleanup. docs/agents/project-context.md does not. It carries a repo's implementation conventions across branches, sessions and agents.
What it is
- Directives to agents: "use X, never Y, here".
- Project-specific facts a model would guess wrong.
- Committed, shared with the team.
It is not documentation for humans, a plan, or session state. Architecture prose belongs in docs/adr/. Vocabulary belongs in GLOSSARY.md.
Line test: would a competent engineer new to this repo get it wrong without the line? If no, cut it. Rubric and worked example: FORMAT.md.
Cap
150 lines / 6 KB, hard. Executors preload this file on every task, so the cap is a per-task token cost. State the cap in the file header. scripts/ci/verify-project-context.sh fails above 150 lines or 6144 bytes. Cut before you add.
Sections
Keep this order. Omit a section that would be empty.
- Stack & versions
- Commands (test, lint, typecheck, build)
- Critical rules
- Patterns to follow
- Patterns to avoid
- Known landmines
Binding semantics
Critical rules are binding. A slice that needs to break one escalates. The caller decides: the rule is stale, or the slice is wrong.
Other sections are strong defaults. Deviate only with a stated reason in the slice report.
Who reads it
- Four agents preload this skill:
orc-implementer,orc-test-author,orc-code-fixer,orc-qa-validator. - Each reads the file once, before discovery.
- A missing file is the default state. Proceed silently, never gate on it.
Who writes it
$orc-contextgenerates, refreshes and appends. Executors never write the file.$orc-retroproposes additions from repeated incidents.- Each proposal passes the line test and the cap, and lands only through a gate.
04 同仓库更多 Skills
writing-plans
Write a comprehensive implementation plan of bite-sized TDD tasks that an engineer with zero codebase context could execute — exact files, code, tests, and verification steps
writing-for-agents
orc's doctrine layer for writing any document an agent consumes — skills, AGENTS.md/CLAUDE.md, reference docs
workspace-mode
Use when cwd is a parent dir holding multiple sibling git repos — defines repo auto-detection, --repos/--repo/--all-repos/--this-repo precedence, per-repo dispatch, and linked-PR mechanics.
wizard
Generate an interactive bash wizard walking a human through work only they can perform — credentials, secrets, one-off migrations
wait-what
Stop and re-pitch — the last message did not land; say it again simply, in the project's own vocabulary.
vitest
Vitest fast unit testing framework powered by Vite with Jest-compatible API