Simplify agents.md for bit Boilerplate (#12228)#12229
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughThe AGENTS.md documentation was restructured and simplified: "Core Principles" and "Available Tooling" sections were removed and content was reorganized into new categories including "Technology Stack," "Project Structure," "Information Gathering & Codebase Investigation," "Critical Command Reference," "Coding Conventions & Best Practices," and "Behavioral Directives." Workflow guidance phrasing was updated and the "Behavioral Directives" section was condensed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Pull request overview
Simplifies the Boilerplate template’s AGENTS.md to a shorter set of actionable instructions while keeping the key tech stack, project structure, and mandatory investigation steps.
Changes:
- Removed the verbose “Core Principles” and step-by-step workflow sections.
- Reorganized and renumbered sections (Technology Stack, Project Structure, investigation steps, commands, conventions).
- Converted the conventions section into a more compact bullet list and moved a couple of directives into “Behavioral Directives”.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
src/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md (2)
63-63: Add missing hyphen in compound modifier.The phrase "realm related" should be hyphenated as "realm-related" when used as a compound modifier before a noun.
✍️ Suggested improvement
-* For Keycloak/realm related tasks, you **MUST** use the `DeepWiki_ask_question` tool with repository `keycloak/keycloak` to find relevant information. +* For Keycloak/realm-related tasks, you **MUST** use the `DeepWiki_ask_question` tool with repository `keycloak/keycloak` to find relevant information.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md` at line 63, Update the compound modifier in the AGENTS.md sentence that mentions Keycloak by changing "realm related" to the hyphenated form "realm-related" (the line that reads: For Keycloak/realm related tasks, you **MUST** use the `DeepWiki_ask_question` tool with repository `keycloak/keycloak`...). Ensure only the compound modifier is hyphenated and preserve the rest of the sentence and backticks around `DeepWiki_ask_question`.
58-58: Use more professional phrasing.The phrase "talks about" is considered informal. Consider using "mentions" or "refers to" for more professional documentation.
✍️ Suggested improvement
-* If the user talks about current changes in the codebase, you **MUST** run the `git --no-pager diff` and `git --no-pager diff --staged` commands to see the differences. +* If the user mentions current changes in the codebase, you **MUST** run the `git --no-pager diff` and `git --no-pager diff --staged` commands to see the differences.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md` at line 58, Replace the informal phrase "talks about" in the sentence "* If the user talks about current changes in the codebase, you **MUST** run the `git --no-pager diff` and `git --no-pager diff --staged` commands to see the differences." with a more professional term such as "mentions" or "refers to" (e.g., "If the user mentions current changes in the codebase..." or "If the user refers to current changes in the codebase...") so the directive remains clear and professional while keeping the required git commands and emphasis intact.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md`:
- Line 63: Update the compound modifier in the AGENTS.md sentence that mentions
Keycloak by changing "realm related" to the hyphenated form "realm-related" (the
line that reads: For Keycloak/realm related tasks, you **MUST** use the
`DeepWiki_ask_question` tool with repository `keycloak/keycloak`...). Ensure
only the compound modifier is hyphenated and preserve the rest of the sentence
and backticks around `DeepWiki_ask_question`.
- Line 58: Replace the informal phrase "talks about" in the sentence "* If the
user talks about current changes in the codebase, you **MUST** run the `git
--no-pager diff` and `git --no-pager diff --staged` commands to see the
differences." with a more professional term such as "mentions" or "refers to"
(e.g., "If the user mentions current changes in the codebase..." or "If the user
refers to current changes in the codebase...") so the directive remains clear
and professional while keeping the required git commands and emphasis intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 1bf8dca1-8dd7-4940-ae19-7def4aa472ec
📒 Files selected for processing (1)
src/Templates/Boilerplate/Bit.Boilerplate/AGENTS.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Yas Moradi <yas_moradi@outlook.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Yas Moradi <yas_moradi@outlook.com>
closes #12228
Summary by CodeRabbit