Skip to content
This repository was archived by the owner on Mar 10, 2026. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -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

Strictly 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
- Always 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.