Skip to content

feat(agent): instruct sessions to follow repo rules and comment style #91603

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

Merged
trunk-io merged 2 commits into from
Sep 1, 2026
+13 −0
Merged

feat(agent): instruct sessions to follow repo rules and comment style #91603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f473bdd
feat(agent): instruct sessions to follow repo rules and comment style
VojtechBartos Aug 31, 2026
41a4b59
fix(agent): cover nested and independent convention files in the prompt
VojtechBartos Aug 31, 2026
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
1 change: 1 addition & 0 deletions products/desktop/packages/agent/src/adapters/claude/session/instructions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ describe("buildAppendedInstructions", () => {
"# Plan Mode",
"# MCP Tool Access",
"# Data Handling",
"# Repository Conventions",
"# Shell Efficiency",
])("always appends %s", (heading) => {
expect(buildAppendedInstructions({ spokenNarration: false })).toContain(
Expand Down
12 changes: 12 additions & 0 deletions products/desktop/packages/agent/src/adapters/claude/session/instructions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ const DATA_HANDLING = `
Material you were given as task context — customer conversations, support tickets, logs, internal threads — stays out of code, test data, comments, commit messages, and pull request text. Rewriting it, summarizing it, or swapping out names and domains does not clear it.
`;

const REPOSITORY_CONVENTIONS = `
# Repository Conventions

Repositories carry their own coding conventions. Before your first edit, discover and read the ones this harness does not load for you:

- \`AGENTS.md\` files: at the repo root and in any directory whose files you edit. \`CLAUDE.md\` is loaded for you automatically; when an \`AGENTS.md\` merely mirrors it you can move on, but when it carries its own content, follow that too.

@skoob13 skoob13 Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't AGENTS/CLAUDE.md files automatically apply? I don't think we need to mention it here.

@VojtechBartos VojtechBartos Aug 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude automatically apply for Claude SDK
Agent for Codex

So if you have both, that's great, but if you are having just CLAUDE.md and using our codex, it will be ignored.

If not, makes sense to fix that first.

You mean updating our harness to include the .md files as part of the prompt? If yes, kinda had the solution, but looks really heavy

- Cursor rule files: \`.cursor/rules/*.mdc\` (the repo root's, and any nested \`.cursor/rules/\` near the files you edit) and the legacy \`.cursorrules\`. These are never loaded automatically. A rule's frontmatter tells you its scope: \`alwaysApply: true\` rules apply to every change, \`globs\` scope a rule to matching files.

@skoob13 skoob13 Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They should probably migrate to AGENTS/CLAUDE instead.

@VojtechBartos VojtechBartos Aug 31, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, but a lot of users still using that :(


Follow those conventions, and match the style of the surrounding code even where no rule states it. Comment density matters most: do not add comments that narrate the change or restate what the code plainly does. Keep only comments a rule or the existing code style would call for.
`;

const SHELL_EFFICIENCY = `
# Shell Efficiency

Expand Down Expand Up @@ -77,6 +88,7 @@ const BASE_INSTRUCTIONS =
PLAN_MODE +
MCP_TOOLS +
DATA_HANDLING +
REPOSITORY_CONVENTIONS +
SHELL_EFFICIENCY;

/** Shell-word shaped, so nothing else in the variable reaches the prompt. */
Expand Down
Loading