Skip to content

chore: add AGENTS.md#2580

Open
M0NsTeRRR wants to merge 1 commit intodevelopfrom
agents-md
Open

chore: add AGENTS.md#2580
M0NsTeRRR wants to merge 1 commit intodevelopfrom
agents-md

Conversation

@M0NsTeRRR
Copy link
Member

@M0NsTeRRR M0NsTeRRR commented Feb 25, 2026

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:

  • I have read and followed the contribution guidelines.
  • Disclosed any use of AI (see our policy)
  • I have updated the documentation accordingly.
  • All new and existing tests passed.
  • Successful build pnpm build
  • Translation keys pnpm i18n:extract
  • Database migration (if required)

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contributor guidelines documentation covering development setup procedures, build and test workflows, code style standards, pull request conventions including Conventional Commits, security vulnerability reporting, translation processes, and community code of conduct to support consistent project maintenance.

Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
@M0NsTeRRR M0NsTeRRR requested a review from a team as a code owner February 25, 2026 22:55
@coderabbitai
Copy link

coderabbitai bot commented Feb 25, 2026

📝 Walkthrough

Walkthrough

Adds 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

Cohort / File(s) Summary
Documentation
AGENTS.md
Introduces comprehensive contribution guidelines for AI agents, including development setup, testing procedures, code standards, pull request conventions with Conventional Commits guidance, and project policies.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • gauthier-th
  • fallenbagel

Poem

🐰 hops excitedly with clipboard
A guide for agents, bright and keen,
To contribute where code is seen,
With rules and paths both clear and neat,
Our AI friends make work complete! ✨

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: add AGENTS.md' directly and clearly summarizes the main change—adding a new documentation file for AI agents.

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


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

Copy link

@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.

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.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55776ea and 549950a.

📒 Files selected for processing (1)
  • AGENTS.md

@caillou
Copy link
Contributor

caillou commented Feb 26, 2026

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants