-
Notifications
You must be signed in to change notification settings - Fork 0
Add AGENTS.md at repository root with updated template naming #11
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # AGENTS.md | ||
|
|
||
| ## 1. Think Before Coding | ||
|
|
||
| **Don't assume. Don't hide confusion. Surface tradeoffs.** | ||
|
|
||
| Before implementing: | ||
| - State your assumptions explicitly. If uncertain, ask. | ||
| - If multiple interpretations exist, present them - don't pick silently. | ||
| - If a simpler approach exists, say so. Push back when warranted. | ||
| - If something is unclear, stop. Name what's confusing. Ask. | ||
|
|
||
| ## 2. Simplicity First | ||
|
|
||
| **Minimum code that solves the problem. Nothing speculative.** | ||
|
|
||
| - No features beyond what was asked. | ||
| - No abstractions for single-use code. | ||
| - No "flexibility" or "configurability" that wasn't requested. | ||
| - No error handling for impossible scenarios. | ||
| - If you write 200 lines and it could be 50, rewrite it. | ||
|
|
||
| Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify. | ||
|
|
||
| ## 3. Surgical Changes | ||
|
|
||
| **Touch only what you must. Clean up only your own mess.** | ||
|
|
||
| When editing existing code: | ||
| - Don't "improve" adjacent code, comments, or formatting. | ||
| - Don't refactor things that aren't broken. | ||
| - Match existing style, even if you'd do it differently. | ||
| - If you notice unrelated dead code, mention it - don't delete it. | ||
|
|
||
| When your changes create orphans: | ||
| - Remove imports/variables/functions that YOUR changes made unused. | ||
| - Don't remove pre-existing dead code unless asked. | ||
|
|
||
| The test: Every changed line should trace directly to the user's request. | ||
|
|
||
| ## 4. Goal-Driven Execution | ||
|
|
||
| **Define success criteria. Loop until verified.** | ||
|
|
||
| Transform tasks into verifiable goals: | ||
| - "Add validation" → "Write tests for invalid inputs, then make them pass" | ||
| - "Fix the bug" → "Write a test that reproduces it, then make it pass" | ||
| - "Refactor X" → "Ensure tests pass before and after" | ||
|
|
||
| For multi-step tasks, state a brief plan: | ||
| ``` | ||
| 1. [Step] → verify: [check] | ||
| 2. [Step] → verify: [check] | ||
| 3. [Step] → verify: [check] | ||
| ``` | ||
Oops, something went wrong.
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 PR description says the AGENTS.md content is preserved exactly from the referenced template (with only the CLAUDE→AGENTS rename), but this file is missing several required sections: the introductory description lines under the header (including the "Behavioral guidelines..." sentence), the Tradeoff: paragraph, the "---" separator, and the final concluding paragraph ("These guidelines are working if..."). Please update AGENTS.md to include the full template content as specified.