mirror of
https://github.com/github/spec-kit.git
synced 2026-08-03 06:26:30 +08:00
a62fb1f034
* docs(extensions): clarify agent-context README and add config examples Rewrite the agent-context extension README to read as plain prose instead of a bullet dump, and add the missing install/disable commands (specify extension add/disable/enable agent-context). Add inline example comments to agent-context-config.yml for context_file/context_files. * docs(agent-context): clarify config documentation - Reformat comments to flow as single-line paragraphs instead of multi-line breaks - Add "WHAT" sections describing each configuration option's purpose - Add "REQUIREMENT" sections specifying if options are optional or required - Add explicit EXAMPLE sections for context_markers configuration - Improve clarity of context_file and context_files option descriptions * docs(agent-context): fix GitHub casing, clarify config - Fix "Github" -> "GitHub" casing in README issues link - Clarify agent-context-config.yml comments on context_file/context_files behavior and precedence * YAML indentation fix for context markers Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(agent-context): simplify README config section - Clarify config file path reference (.specify/extensions path vs repo path) - Remove duplicated YAML example/field docs from README, point to config file directly - Minor spacing fix in agent-context-config.yml comment * docs(agent-context): clarify config file path in README - Reference the installed .specify config path alongside the repo-relative link * docs(agent-context): clarify install and marker requirement - README: clarify install command must be run from an initialized Spec Kit project root - config: correct context_markers requirement from REQUIRED to OPTIONAL * Wording Fix Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(agent-context): clarify context_file path rules - Document that context_file/context_files are relative to the project root (directory containing .specify/) - State the rejected path forms (absolute paths, backslash separators, .. segments) directly in each field's WHAT comment * Updated supported invocation syntaxes Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Extension Disable Clarification Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(agent-context): document .mdc frontmatter exception - Clarify that .mdc files get alwaysApply: true set in frontmatter, outside the managed marker block - Fix "Everything else is untouched" wording so it doesn't contradict the exception right above it --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
25 lines
1.4 KiB
YAML
25 lines
1.4 KiB
YAML
# Coding Agent Context Extension Configuration
|
|
|
|
# WHAT: The single agent context file relative to the project root (the directory containing .specify/). Absolute paths, backslash separators, and `..` path segments are rejected.
|
|
# REQUIREMENT: OPTIONAL. Use this if you want to manually specify a single context file. If you leave this entry blank, it will use the default context file for the coding agent you picked when you set up Spec Kit. See `agent-context-defaults.json` for the defaults.
|
|
# EXAMPLE: context_file: CLAUDE.md
|
|
context_file: ""
|
|
|
|
# WHAT: List of agent context files relative to the project root (the directory containing .specify/). If you have both `context_file` and `context_files` filled, then this (`context_files`) takes precedence. Absolute paths, backslash separators, and `..` path segments are rejected.
|
|
# REQUIREMENT: OPTIONAL. Use this if your project requires you to keep multiple agent context files in sync.
|
|
# EXAMPLE:
|
|
# context_files:
|
|
# - AGENTS.md
|
|
# - CLAUDE.md
|
|
context_files: []
|
|
|
|
# WHAT: Markers (delimiters) for the managed Spec Kit section. This extension injects information only between these markers.
|
|
# REQUIREMENT: OPTIONAL. 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 -->"
|