Conversation
…include .md files
📝 WalkthroughWalkthroughAdds two AGENTS.md documentation files (root and template-compose) describing an Android project template and generator, and updates Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
Kover report for template-compose:🧛 Template - Compose Unit Tests Code Coverage:
|
| File | Coverage |
|---|
Modified Files Not Found In Coverage Report:
AGENTS.md
AGENTS.md
new_project.kts
Codebase cunningly covered by count Shroud 🧛
Generated by 🚫 Danger
…technology stack and guidelines
There was a problem hiding this comment.
🧹 Nitpick comments (2)
AGENTS.md (1)
22-28: Consider specifying a language for the code block.The fenced code block should include a language identifier for proper syntax highlighting and markdown compliance. Use
textorplaintextfor ASCII diagrams.📝 Proposed fix
-``` +```text /scripts → Generator script (new_project.kts) /template-compose → Source template (see its AGENTS.md for Android guidance)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 22 - 28, The fenced code block in AGENTS.md lacks a language identifier; update the triple-backtick fence to include a language (e.g., ```text or ```plaintext) so the ASCII directory listing (/scripts, /template-compose, /sample-compose, /build-logic, /.github) is correctly highlighted and compliant with Markdown rendering; modify the code block surrounding those lines in AGENTS.md to start with ```text and keep the existing contents unchanged.template-compose/AGENTS.md (1)
37-59: Consider specifying a language for the architecture diagram.The fenced code block should include a language identifier for proper markdown compliance. Use
textfor ASCII diagrams.📝 Proposed fix
-``` +```text ┌─────────────────────────────────────────────────────┐ │ app/ │🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@template-compose/AGENTS.md` around lines 37 - 59, Update the fenced ASCII architecture diagram so the opening code fence includes a language identifier (use "text") for proper Markdown compliance; locate the block that begins with the triple backticks containing the ASCII diagram (the diagram lines starting with "┌─────────────────────────────────────────────────────┐" and the directory layout like "app/", "domain/", "data/") and change the opening fence to include the language label (e.g., replace ``` with ```text) so the diagram renders as plain text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@AGENTS.md`:
- Around line 22-28: The fenced code block in AGENTS.md lacks a language
identifier; update the triple-backtick fence to include a language (e.g.,
```text or ```plaintext) so the ASCII directory listing (/scripts,
/template-compose, /sample-compose, /build-logic, /.github) is correctly
highlighted and compliant with Markdown rendering; modify the code block
surrounding those lines in AGENTS.md to start with ```text and keep the existing
contents unchanged.
In `@template-compose/AGENTS.md`:
- Around line 37-59: Update the fenced ASCII architecture diagram so the opening
code fence includes a language identifier (use "text") for proper Markdown
compliance; locate the block that begins with the triple backticks containing
the ASCII diagram (the diagram lines starting with
"┌─────────────────────────────────────────────────────┐" and the directory
layout like "app/", "domain/", "data/") and change the opening fence to include
the language label (e.g., replace ``` with ```text) so the diagram renders as
plain text.
…ile names in documentation
There was a problem hiding this comment.
🧹 Nitpick comments (2)
AGENTS.md (1)
22-27: Add language specifier to the code block.The fenced code block lacks a language specifier, which improves rendering and accessibility.
📝 Proposed fix
-``` +```text /scripts → Generator script (new_project.kts) /template-compose → Source template (see its AGENTS.md for Android guidance) /sample-compose → Example output (regenerate, don't edit directly) /.github → CI workflows and PR templates</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@AGENTS.mdaround lines 22 - 27, Add a language specifier to the fenced code
block containing the listing (the block with lines like "/scripts → Generator
script (new_project.kts)", "/template-compose → Source template (see its
AGENTS.md for Android guidance)", etc.); change the opening fence fromtotext (or ```plaintext) so the block is explicitly marked as plain text for
better rendering and accessibility.</details> </blockquote></details> <details> <summary>template-compose/AGENTS.md (1)</summary><blockquote> `37-59`: **Add language specifier to the code block.** The architecture diagram code block lacks a language specifier. Adding `text` or `plaintext` improves rendering consistency. <details> <summary>📝 Proposed fix</summary> ```diff -``` +```text ┌─────────────────────────────────────────────────────┐ │ app/ │ │ ├── di/ → Hilt modules │ ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@template-compose/AGENTS.mdaround lines 37 - 59, The fenced ASCII
architecture diagram code block (the one starting with the top border
"┌─────────────────────────────────────────────────────┐") is missing a language
specifier; update the opening triple backticks to include a plain text specifier
(for example changetotext or ```plaintext) so the diagram renders
consistently across renderers.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In@AGENTS.md:
- Around line 22-27: Add a language specifier to the fenced code block
containing the listing (the block with lines like "/scripts → Generator script
(new_project.kts)", "/template-compose → Source template (see its AGENTS.md for
Android guidance)", etc.); change the opening fence fromtotext (orrendering and accessibility. In `@template-compose/AGENTS.md`: - Around line 37-59: The fenced ASCII architecture diagram code block (the one starting with the top border "┌─────────────────────────────────────────────────────┐") is missing a language specifier; update the opening triple backticks to include a plain text specifier (for example change ``` to ```text or ```plaintext) so the diagram renders consistently across renderers.
Solves #618
What happened 👀
Add AGENTS.md files to guide AI coding assistants (Gemini, Copilot, Cursor, etc.) when working on this repo.
Changes:
AGENTS.mdwith generator commands, placeholders, and project structuretemplate-compose/AGENTS.mdwith Android-specific architecture, code style, and patternsnew_project.ktsto include.mdfiles in package name replacementInsight 📝
AGENTS.mdcontains the placeholder package nameco.nimblehq.template.compose. Adding .md to the file filter ensures generated projects get correct paths in theirAGENTS.md.References:
Proof Of Work 📹
Sections follow AGENTS.md standard (6 core areas):
Summary by CodeRabbit
Documentation
Chores