-
Notifications
You must be signed in to change notification settings - Fork 10.5k
docs(extensions): clarify agent-context README and add config examples #3389
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.
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
yanukadeneth99
wants to merge
2
commits into
github:main
Choose a base branch
from
yanukadeneth99:docs/agent-context-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+52
−30
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,25 @@ | ||
| # Coding Agent Context Extension Configuration | ||
| # These values are populated automatically by `specify init` and | ||
| # `specify integration use` / `specify integration install`. | ||
| # These values are populated automatically by `specify init` and `specify integration use` / `specify integration install`. | ||
|
|
||
| # Path (relative to the project root) to the default coding agent context file | ||
| # managed by this extension (e.g. CLAUDE.md, AGENTS.md, | ||
| # .github/copilot-instructions.md). Set automatically from the active | ||
| # integration and regenerated during `specify init` or integration switches. | ||
| # WHAT: Single Project-relative path to the main coding agent context file. | ||
| # REQUIREMENT: OPTIONAL. If you leave this entry blank, the bundled update scripts will automatically fill this in based on the active integration's key. | ||
| # EXAMPLE: context_file: CLAUDE.md | ||
| context_file: "" | ||
|
|
||
| # Optional list of project-relative coding agent context files managed by this | ||
| # extension. When non-empty, this list takes precedence over `context_file`. | ||
| # Use this for projects that intentionally keep multiple agent anchors in sync. | ||
| # WHAT: List of project-relative coding agent context file paths managed by this extension. If you have both `context_file` and `context_files`, then `context_files` takes precedence. | ||
| # REQUIREMENT: OPTIONAL. Use this if your project requires you to keep multiple agent files in sync. | ||
| # EXAMPLE: | ||
| # context_files: | ||
| # - AGENTS.md | ||
| # - CLAUDE.md | ||
| context_files: [] | ||
|
|
||
| # Delimiters for the managed Spec Kit section. | ||
| # Edit these to use custom markers. | ||
| # WHAT: Markers (Delimiters) for the managed Spec Kit section. All information injected by this extension will only be done in between these markers. | ||
| # REQUIREMENT: REQUIRED. Only change if you wish to have a custom marker name. | ||
| # EXAMPLE: | ||
| # context_markers: | ||
| # start: "<!-- AGENT SPEC KIT CONTEXT START -->" | ||
| # end: "<!-- AGENT SPEC KIT CONTEXT END -->" | ||
| context_markers: | ||
| start: "<!-- SPECKIT START -->" | ||
| end: "<!-- SPECKIT END -->" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
# EXAMPLE: context_file: CLAUDE.mdhere reads as ifcontext_fileis something you're expected to fill in. But empty is the intended default — that's what triggers the self-seed fromagent-context-defaults.jsonbased on the active integration. If someone copies the example and pinsCLAUDE.md, they've overridden the auto-resolution, so switching agents later (e.g. to Copilot) will keep writing the managed block toCLAUDE.mdinstead of.github/copilot-instructions.md.Could we reframe it so it's clear this is an override, not a required value? Something like:
The
context_filesexample below is fine as-is, since multi-anchor sync genuinely requires the user to list paths explicitly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, and that makes sense.
I updated the whole document to make things clearer. Hope this is all good @mnriem
Let me know if you want me to take a look again.