docs: keep AI guidance optional in the template - #2
Merged
yujeongdev merged 1 commit intoMar 27, 2026
Merged
Conversation
Copy link
Copy Markdown
Owner
Sorry, something went wrong.
This template should stay neutral about agent tooling. Instead of shipping opinionated AGENTS.md or CLAUDE.md files, the README now briefly notes that downstream projects can add them later if they want project-specific guidance. Constraint: Template repos should avoid baking in one team's AI workflow preferences Rejected: Ship placeholder AGENTS.md and CLAUDE.md files | still adds default agent surface area to every generated project Confidence: high Scope-risk: narrow Reversibility: clean Directive: Keep AI-tooling guidance optional unless the template itself depends on it Tested: make check Not-tested: PR rendering on GitHub
Copy link
Copy Markdown
There was a problem hiding this comment.
Pull request overview
Updates the template documentation to keep AI/agent tooling guidance optional and non-prescriptive, aligning the template with a neutral default stance while still explaining how downstream projects can add such guidance later.
Changes:
- Add an “Optional AI guidance files” section to clarify that AGENTS.md/CLAUDE.md are not shipped by default.
- Document that downstream projects can introduce these files later with project-specific instructions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Testing