Skip to content

[#618] Add AGENTS.md#626

Merged
hoangnguyen92dn merged 4 commits intodevelopfrom
chore/618-add-agentsmd
Feb 27, 2026
Merged

[#618] Add AGENTS.md#626
hoangnguyen92dn merged 4 commits intodevelopfrom
chore/618-add-agentsmd

Conversation

@thawzintoe-ptut
Copy link
Copy Markdown
Contributor

@thawzintoe-ptut thawzintoe-ptut commented Feb 4, 2026

Solves #618

What happened 👀

Add AGENTS.md files to guide AI coding assistants (Gemini, Copilot, Cursor, etc.) when working on this repo.
Changes:

  • Add root AGENTS.md with generator commands, placeholders, and project structure
  • Add template-compose/AGENTS.md with Android-specific architecture, code style, and patterns
  • Update new_project.kts to include .md files in package name replacement

Insight 📝

  • Root file covers the generator workflow
  • Template file covers Android development patterns (gets copied to generated projects)
  • The template AGENTS.md contains the placeholder package name co.nimblehq.template.compose. Adding .md to the file filter ensures generated projects get correct paths in their AGENTS.md.

References:

Proof Of Work 📹

Sections follow AGENTS.md standard (6 core areas):

Section Root Template
Commands
Testing
Architecture
Code Style
Git Workflow
Boundaries

Summary by CodeRabbit

  • Documentation

    • Added comprehensive agent and template guidelines for the Android project generator: architecture standards, technology stack, modular project layout, UI patterns, build/test/coverage commands, CI/CD and Git workflows, security practices, code style rules, testing frameworks, coverage targets, and enforcement boundaries.
  • Chores

    • Improved package-renaming to also update documentation files so generated projects remain consistent.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

Adds two AGENTS.md documentation files (root and template-compose) describing an Android project template and generator, and updates scripts/new_project.kts to include .md files in the package-name replacement step during project generation.

Changes

Cohort / File(s) Summary
Root documentation
AGENTS.md
New top-level documentation describing the Android project template generator: technology stack, project structure, commands, CI/CD, template placeholders, Git workflow, and agent boundaries.
Template documentation
template-compose/AGENTS.md
New template-specific documentation codifying architecture and Nimble Compass conventions: stack (Kotlin, Compose, MVVM/Clean, Hilt), module layout, code style, testing & coverage targets, CI, and enforcement guidelines.
Script change
scripts/new_project.kts
Expanded renamePackageNameWithinFiles file filter to include .md files so package-name replacements run in Markdown files as well as .kt, .xml, and .gradle.kts.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰
I hopped through folders, nibbling lines of guide,
New rules and templates now hop side by side,
Markdown names updated, tidy through and through,
May builds be brisk and linting gentle too! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title '[#618] Add AGENTS.md' clearly and concisely describes the main change: adding AGENTS.md documentation files to the project.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/618-add-agentsmd

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 4, 2026

14 Warnings
⚠️ Uh oh! Your project is under 80% coverage!
⚠️ template-compose/gradle/libs.versions.toml#L10 - A newer version of androidx.compose:compose-bom than 2025.02.00 is available: 2026.02.00
⚠️ template-compose/gradle/libs.versions.toml#L12 - A newer version of androidx.navigation:navigation-compose than 2.5.3 is available: 2.9.7
⚠️ template-compose/gradle/libs.versions.toml#L13 - A newer version of androidx.core:core-ktx than 1.15.0 is available: 1.17.0
⚠️ template-compose/gradle/libs.versions.toml#L14 - A newer version of androidx.datastore:datastore-preferences than 1.1.3 is available: 1.2.0
⚠️ template-compose/gradle/libs.versions.toml#L17 - A newer version of com.android.application than 8.8.2 is available: 9.0.1
⚠️ template-compose/gradle/libs.versions.toml#L17 - A newer version of com.android.library than 8.8.2 is available: 9.0.1
⚠️ template-compose/gradle/libs.versions.toml#L19 - A newer version of androidx.hilt:hilt-navigation-compose than 1.2.0 is available: 1.3.0
⚠️ template-compose/gradle/libs.versions.toml#L25 - A newer version of org.jetbrains.kotlinx:kotlinx-coroutines-core than 1.7.3 is available: 1.10.2
⚠️ template-compose/gradle/libs.versions.toml#L25 - A newer version of org.jetbrains.kotlinx:kotlinx-coroutines-test than 1.7.3 is available: 1.10.2
⚠️ template-compose/gradle/libs.versions.toml#L28 - A newer version of androidx.lifecycle:lifecycle-runtime-compose than 2.8.7 is available: 2.10.0
⚠️ template-compose/gradle/libs.versions.toml#L28 - A newer version of androidx.lifecycle:lifecycle-runtime-ktx than 2.8.7 is available: 2.10.0
⚠️ template-compose/gradle/libs.versions.toml#L35 - A newer version of androidx.security:security-crypto than 1.0.0 is available: 1.1.0
⚠️ template-compose/gradle/libs.versions.toml#L36 - A newer version of androidx.test:core-ktx than 1.6.1 is available: 1.7.0

Kover report for template-compose:

🧛 Template - Compose Unit Tests Code Coverage: 73.20%

Coverage of Modified Files:

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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 text or plaintext for 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 text for 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.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b907068 and f6227f1.

📒 Files selected for processing (2)
  • AGENTS.md
  • template-compose/AGENTS.md

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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.md around 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 from totext (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.md around 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 change totext 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 from totext (or
rendering 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.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6227f1 and e502787.

📒 Files selected for processing (2)
  • AGENTS.md
  • template-compose/AGENTS.md

@hoangnguyen92dn hoangnguyen92dn merged commit 2a72ba8 into develop Feb 27, 2026
5 of 6 checks passed
@hoangnguyen92dn hoangnguyen92dn deleted the chore/618-add-agentsmd branch February 27, 2026 08:07
This was referenced Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants