Conversation
Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
📝 WalkthroughWalkthroughAdds a new AGENTS.md documentation file that provides guidelines for AI agents on contributing to the project, covering project overview, development setup, build and test procedures, database migrations, code style, translations, pull request conventions, security reporting, documentation structure, and code of conduct. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Line 72: Clarify that the example DB credentials in the AGENTS.md command
(DB_TYPE, DB_USER, DB_PASS) are only for local development and must not be used
in production; update the line containing "DB_TYPE=\"postgres\" DB_USER=postgres
DB_PASS=postgres pnpm migration:generate
server/migration/postgres/YourMigrationName" to include a short caveat or note
that these are local-dev defaults and recommend using secure,
environment-specific credentials (or a secrets manager) for non-local
environments.
- Around line 54-60: Update the CI workflow description to mention the project's
type-checking commands: add `pnpm typecheck` (and note the available variants
`typecheck:client` and `typecheck:server`) to the list of checks agents should
run locally and in CI (refer to the CI workflow summary and command list in
AGENTS.md); also rephrase the hedged sentence about tests to a direct statement
such as "This project does not include unit tests." so readers know there are no
unit test scripts to run.
|
I've personally never used an agent file. I have the feeling that it's very hard to not write things that are counter productive. Not that I have a lot of experience. Recently there has been a study that seems to support this intuition: https://news.ycombinator.com/item?id=47034087 Sometimes it helps, often it doesn't. I leave this as a comment, this is just an intuition of mine. I especially have little experience with the agents... Feel free to ignore. |
Description
The purpose of this file is to provide specific, actionable instructions for AI agents and automated tooling to follow when contributing to this repository. This helps ensure that AI-assisted contributions align with the project's standards, conventions, and procedures.
This file was generated by the Gemini CLI under my supervision.
How Has This Been Tested?
Screenshots / Logs (if applicable)
Checklist:
pnpm buildpnpm i18n:extractSummary by CodeRabbit