Skip to content

docs: add agent citation and PR cross-reference rules #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Gandy2025 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add agent citation and PR cross-reference rules #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions assets/framework/templates/agents.md.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Do not skip this. The tree is already a compression of expensive knowledge — c
- **The tree is not for execution details.** Function signatures, DB schemas, API endpoints, ad copy — those live in source systems. The tree captures the *why* and *how things connect*.
- **Bring source repos in as additional working directories.** When you need to inspect or edit code, open the relevant source repositories alongside this tree instead of copying execution detail into the tree.
- **Respect ownership.** Each node declares owners in its frontmatter. If your changes touch a domain you don't own, flag it — the owner needs to review.
- **Cite the tree when it matters.** When a tree node influenced your decision — changed your approach, ruled out an option, or surfaced a constraint — mention it naturally: "Based on kael/chat-ux.md, streaming is required here" or "This conflicts with the constraint in platform/auth.md." Don't cite every read; cite the ones that shaped the outcome.

## After Every Task

Expand All @@ -43,6 +44,7 @@ Ask yourself: **Does the tree need updating?**
- Not every task changes the tree, but the question must always be asked.
- If the task changed decisions, constraints, rationale, or ownership, open the tree PR first. Then open the source/workspace code PR.
- If the task changed only implementation details, skip the tree PR and open only the source/workspace code PR.
- **Link tree PRs and code PRs.** When a task produces both a tree PR and a code PR, cross-reference them in the PR body: tree PR links to `Code PR: owner/repo#N`, code PR links to `Tree PR: owner/tree-repo#N`.

## Reference

Expand Down
Loading