From d404afa9e31c86636d9007160b6459539210e105 Mon Sep 17 00:00:00 2001 From: Pierre Poulain Date: Tue, 27 Jan 2026 22:13:44 +0100 Subject: [PATCH 1/2] chore: Add instructions for AI agents --- AGENTS.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..18bf5df --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,62 @@ + +# Instructions for AI agent + +## Code base + +This repository is a Python project, which dependencies are managed with uv. + +Code organization: + +- `src` directory: main code +- `tests` directory: tests handled by `pytest` +- `docs` directory: documentation + +Stricly follow data models and structures. + +## Code style + +When writing code: + +- Follow PEP 8 and PEP 257 +- Keep code consistent, easy to understand yet pythonic +- Add meaningful variable names +- Add explanatory comments describing the purpose of the code + +When writing functions, always: + +- Add descriptive docstrings. +- Use early returns for error conditions + +Never import libraries by yourself. Always ask before adding dependencies. + +## Code review + +When reviewing code, focus on: + +### Security issues + +- Check for hardcoded secrets, API keys, or credentials +- Look for SQL injection and XSS vulnerabilities +- Verify proper input validation and sanitization + +### Performance red flags + +- Spot inefficient loops and algorithmic issues +- Review caching opportunities for expensive operations + +### Code quality + +- Functions should be focused and appropriately sized +- Use clear, descriptive naming conventions +- Ensure proper error handling throughout + +### Review style + +- Be specific and actionable in feedback +- Alwaus explain the "why" behind recommendations +- Acknowledge good patterns when you see them +- Ask clarifying questions when code intent is unclear + +Always prioritize security vulnerabilities and performance issues that could impact users. + +Always suggest changes to improve readability. From 21a32804c07408c9e9d5e3ac63d5a5b0dc2489b4 Mon Sep 17 00:00:00 2001 From: Pierre Poulain Date: Wed, 28 Jan 2026 18:14:53 +0100 Subject: [PATCH 2/2] docs: Fix typos --- AGENTS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 18bf5df..6813b72 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -11,7 +11,7 @@ Code organization: - `tests` directory: tests handled by `pytest` - `docs` directory: documentation -Stricly follow data models and structures. +Strictly follow data models and structures. ## Code style @@ -53,7 +53,7 @@ When reviewing code, focus on: ### Review style - Be specific and actionable in feedback -- Alwaus explain the "why" behind recommendations +- Always explain the "why" behind recommendations - Acknowledge good patterns when you see them - Ask clarifying questions when code intent is unclear