Repository navigation
#10670: Add AGENTS.md for AI coding assistant guidance - #215
Conversation
Addresses mosip/mosip-config#10670 — provides repository overview, tech stack, build/test commands, configuration notes, and contribution guidelines for AI agents and contributors working across the mock-plugin, mosip-identity-plugin, and sunbird-rc-plugin modules. Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
WalkthroughAdded ChangesRepository Guidance
Estimated code review effort: 1 (Trivial) | ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
![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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 69-74: Update the single-test Maven command in AGENTS.md so the
-Dtest=MockAuthenticationServiceTest system property appears before the test
goal, while preserving the mock-plugin directory and targeted test class.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
-Dtest must come before the test goal for it to take effect. Addresses review comment on mosip#215 Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
AGENTS.md (1)
176-177: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winScope the single-module rule to plugin implementation changes.
The current wording also covers valid repository-level work, such as
AGENTS.md, workflow files, and shared documentation. An agent could reject a required repository-level change. Preserve module isolation for plugin code, but document an exception for repository-level changes.Proposed fix
-1. Work inside a single module directory (`mock-plugin`, `mosip-identity-plugin`, or `sunbird-rc-plugin`) per change, and run that module's own `mvn clean install` / `mvn test` before proposing a change as complete. +1. For plugin implementation changes, work inside a single module directory (`mock-plugin`, `mosip-identity-plugin`, or `sunbird-rc-plugin`), and run that module's own `mvn clean install` / `mvn test` before proposing a change as complete. + Repository-level documentation, workflow, and shared configuration changes may modify the required root-level files.Based on learnings: “Work inside a single module per change unless a cross-module change is explicitly required.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` around lines 176 - 177, Update the single-module rule in AGENTS.md to apply specifically to plugin implementation changes, while allowing repository-level changes such as AGENTS.md, workflow files, and shared documentation to span modules when required. Preserve the requirement to run the affected module’s Maven checks and retain the module README guidance for configuration changes.Source: Learnings
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@AGENTS.md`:
- Around line 176-177: Update the single-module rule in AGENTS.md to apply
specifically to plugin implementation changes, while allowing repository-level
changes such as AGENTS.md, workflow files, and shared documentation to span
modules when required. Preserve the requirement to run the affected module’s
Maven checks and retain the module README guidance for configuration changes.
Maven's CLI parser accepts -D properties in either position relative to the goal, unlike a plain java -jar command where the JVM stops parsing options at -jar. The previous rule incorrectly applied the java -jar requirement to Maven too. Standardize the examples on -D after the goal (mvn clean install -Dfoo=bar), matching common Maven convention, and correct the stated rule. Self-correction: found while fixing the same mistake in mosip/esignet-signup#956 Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
|
Self-correction (not prompted by an active CodeRabbit comment here): the |
Adds mock-plugin/AGENTS.md, mosip-identity-plugin/AGENTS.md, and sunbird-rc-plugin/AGENTS.md, documenting each module's dual esignet-integration-api/signup-integration-api package layout (where applicable), implemented interfaces, and key classes. Notably flags that mosip-identity-plugin (the production plugin) still ships a MockIdentityVerifierPluginImpl for signup identity verification. Root AGENTS.md now links to each. Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
- Add -Dgpg.skip=true to every mvn clean install example (root and per-module AGENTS.md): each module's maven-gpg-plugin binds sign to the verify phase, which install runs through, so local builds fail without a signing key unless skipped. - sunbird-rc-plugin/AGENTS.md: remove the "don't drive-by rename the misspelled test file" Do-not item, per maintainer request. Addresses review comments on mosip#215 Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
Consolidate facts restated 2-3x across sections ("target develop",
"no root pom.xml", mock-plugin not-for-production warning, -D CLI
ordering rationale, provided-scope dependency rule) down to one
statement each, and tighten prose.
477 -> 388 lines across root + 3 module guides. Every command,
-Dgpg.skip=true flag, and security warning kept, just tighter.
Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
3 participants
Addresses mosip/mosip-config#10670 — adds a root AGENTS.md giving AI coding assistants and contributors a repository overview, tech stack, build/test commands, configuration notes, and PR guidelines for the mock-plugin, mosip-identity-plugin, and sunbird-rc-plugin modules.
Summary by CodeRabbit