chore: Update AGENTS.md for more efficient use.#515
Conversation
Breaks up the AGENTS.md for Gemini so that it can better process and keep the context.
WalkthroughThis change refactors agent guidelines documentation from a single comprehensive file into modular, focused reference documents covering communication protocols, constraints, coding frameworks, and testing standards. The original AGENTS.md is streamlined to reference these external documents. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@prompts/agents/CONSTRAINTS.md`:
- Around line 11-19: Update the nested list under the "Path-Scoped Commits"
section to use 2-space indentation (instead of 4) so markdownlint MD007 passes:
adjust the two nested list items ("Commit tracked files with:" and "Add and
commit new files explicitly:") and their fenced bash code blocks to align with
2-space nesting (e.g., two spaces before the hyphen and two spaces further for
the code fence lines), leaving the content of the code blocks unchanged.
🧹 Nitpick comments (1)
prompts/agents/CONSTRAINTS.md (1)
2-5: Optional: vary repeated “DO NOT” phrasing.Minor readability tweak—four consecutive bullets start the same way. Consider mixing phrasing for scanability.
| - **Path-Scoped Commits**: Commit only the files you modified. | ||
| - Commit tracked files with: | ||
| ```bash | ||
| git commit -m "<scoped message>" -- path/to/file1 path/to/file2 | ||
| ``` | ||
| - Add and commit new files explicitly: | ||
| ```bash | ||
| git add path/to/new/file && git commit -m "<message>" | ||
| ``` |
There was a problem hiding this comment.
Fix list indentation to satisfy markdownlint (MD007).
The nested list items are indented by 4 spaces; markdownlint expects 2 here.
Proposed fix
- - Commit tracked files with:
- ```bash
- git commit -m "<scoped message>" -- path/to/file1 path/to/file2
- ```
- - Add and commit new files explicitly:
- ```bash
- git add path/to/new/file && git commit -m "<message>"
- ```
+ - Commit tracked files with:
+ ```bash
+ git commit -m "<scoped message>" -- path/to/file1 path/to/file2
+ ```
+ - Add and commit new files explicitly:
+ ```bash
+ git add path/to/new/file && git commit -m "<message>"
+ ```📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Path-Scoped Commits**: Commit only the files you modified. | |
| - Commit tracked files with: | |
| ```bash | |
| git commit -m "<scoped message>" -- path/to/file1 path/to/file2 | |
| ``` | |
| - Add and commit new files explicitly: | |
| ```bash | |
| git add path/to/new/file && git commit -m "<message>" | |
| ``` | |
| - **Path-Scoped Commits**: Commit only the files you modified. | |
| - Commit tracked files with: |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
12-12: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🤖 Prompt for AI Agents
In `@prompts/agents/CONSTRAINTS.md` around lines 11 - 19, Update the nested list
under the "Path-Scoped Commits" section to use 2-space indentation (instead of
4) so markdownlint MD007 passes: adjust the two nested list items ("Commit
tracked files with:" and "Add and commit new files explicitly:") and their
fenced bash code blocks to align with 2-space nesting (e.g., two spaces before
the hyphen and two spaces further for the code fence lines), leaving the content
of the code blocks unchanged.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #515 +/- ##
==========================================
Coverage 48.63% 48.63%
Complexity 474 474
==========================================
Files 65 65
Lines 2204 2204
Branches 312 312
==========================================
Hits 1072 1072
Misses 1001 1001
Partials 131 131
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
Breaks up the AGENTS.md for Gemini so that it can better process and keep the context.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.