#10670: Add AGENTS.md for AI coding assistant guidance - #126
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: WalkthroughAdded root-level 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: 2
🤖 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 105-108: Update the test documentation in AGENTS.md to describe
test support per module, removing the repository-wide claim that none of the
three modules has an automated test suite. Preserve the existing mds-test-ui npm
test and e2e commands, and accurately distinguish the Maven modules’ available
test targets from the UI module’s workflows.
- Around line 123-130: Update the AGENTS.md guidance for PrivateKey.pem,
PrivateKey_old.pem, and commonData.properties, including the corresponding
section around the later duplicate entries, to treat all committed credentials,
provider data, and private keys as exposed secrets: remove or redact the
sensitive values, direct contributors to managed local or environment-based
secret configuration, and require rotation or revocation of existing repository
credentials and keys.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Addresses mosip/mosip-config#10670 - provides a repository overview, tech stack, per-module build/test commands, configuration notes, and contribution guidelines for AI agents and contributors working in this repo. Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
chetankh239
force-pushed
the
agents-md-doc
branch
from
August 10, 2026 06:18
17084e7 to
76116a0
Compare
…wording Correct the internal contradiction where AGENTS.md claimed no module has an automated test suite while also documenting mds-test-ui's npm run test/e2e commands (Karma/Protractor tests genuinely exist there; the Java modules have no src/test sources). Also reword the committed-credentials guidance (PrivateKey.pem/PrivateKey_old.pem, commonData.properties) so it doesn't read as minimizing real, already-committed sandbox credentials. Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 177-182: Update the workflow guidance in AGENTS.md to scope the
module build/test requirement to module source or configuration changes,
explicitly excluding repository-root documentation such as AGENTS.md. For
root-only documentation edits, require Markdown and command-reference validation
instead of running an unrelated module build, and apply the same exception to
the repeated guidance referenced elsewhere.
- Around line 119-121: Update the AGENTS.md documentation entry for
mosip-device-service so the <pwd> placeholder is not described as the database
password. Identify the exact database property from bootstrap.properties, or
explicitly describe <pwd> as the IDA authentication secret, while preserving the
surrounding endpoint and configuration guidance.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
- Treat the committed PrivateKey.pem/PrivateKey_old.pem and commonData.properties credentials as compromised (public repo), not just sandbox fixtures — recommend rotation and a managed secret store instead of a tracked file. - Correctly attribute the two separate <pwd> placeholders: ida.auth.secretkey in application.properties vs. javax.persistence.jdbc.password (the actual DB password) in bootstrap.properties. - Add a repository-root documentation exception to the per-module-build workflow rule, since AGENTS.md itself covers all three modules and has no module build to run. Addresses review comments on mosip#126 Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
Author
|
Addressed the remaining CodeRabbit findings in the latest commit (test-suite statement was already fixed earlier).
|
Fix wrong default port (8080 -> 8081) for mosip-device-service and the UI's base_url, name the TestManagerController mounting path explicitly, correct MDS to MOSIP Device Service, point branch/PR guidance at develop (the active integration branch, confirmed via recent PR targets) instead of master, list rp-partner.p12 and the live-looking application.properties values in the secrets inventory, and correct the dbFiles description to multiple configs per environment. Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
chetankh239
force-pushed
the
agents-md-doc
branch
from
August 24, 2026 10:23
175a094 to
dd65aa6
Compare
Shorten the PrivateKey.pem/rp-partner.p12 and commonData.properties Configuration bullets to a pointer instead of repeating the full "treat as compromised, rotate, flag to maintainer" explanation already stated in Repository-Specific Considerations. Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
JanardhanBS-SyncByte
approved these changes
Aug 26, 2026
Consolidate facts restated 3-4x across sections (master-vs-develop branch guidance, no-CI/no-Dockerfile fact, DeviceRegister vs DeviceRegisterAndDeRegister confusion note, committed-credentials warning) down to one clear statement each, and tighten prose. 264 -> 86 lines. Every command, path, port number, and safety-critical fact kept, just no restated explanations. Signed-off-by: Chetan Kumar Hirematha <chetankumar.h.239@gmail.com>
Prafulrakhade
approved these changes
Aug 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses mosip/mosip-config#10670 — adds a root AGENTS.md covering the repo's three independent modules (mds-test-ui Angular app, mosip-device-service Spring Boot backend, mosip-device-reg Java CLI utilities), their real build/run commands, configuration/secrets locations, and contribution guidelines for AI agents and human contributors.
Summary by CodeRabbit