Skip to content

Agents markdown file #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
NoneGG wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Agents markdown file #229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 44 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# AGENTS.md

This file provides context and guidelines for AI agents working on the `aredis` repository.

## Project Overview

`aredis` is an efficient and user-friendly async Redis client for Python, ported from `redis-py`. It allows interaction with Redis using Python's `asyncio` framework.

## Development Guidelines

### Language and Style
- **Language**: Python (supports Python 3.8+).
- **Style**: Follow PEP 8 coding standards.
- **Asyncio**: This is an asynchronous library. Ensure all I/O operations are non-blocking and use `async`/`await` syntax where appropriate.

### Code Structure
- **Source Code**: Located in the `aredis/` directory.
- **Tests**: Located in the `tests/` directory.
- **Benchmarks**: Located in the `benchmarks/` directory.
- **Documentation**: Located in the `docs/` directory (Sphinx-based).
- **Examples**: Usage examples are in the `examples/` directory.

## Testing

- The project uses `pytest` for testing.
- Run tests using `pytest` or `python setup.py test`.
- Ensure new features or bug fixes include appropriate test coverage in the `tests/` directory.
- For performance-critical changes, consider running scripts in `benchmarks/` to ensure no regression.

## Documentation

- Documentation is written in reStructuredText (`.rst`) and built with Sphinx.
- Update documentation in `docs/source/` when adding new features or changing public APIs.

## Dependencies

- Core dependencies are listed in `setup.py`.
- Development dependencies are in `dev_requirements.txt`.
- Test dependencies are in `test_requirements.txt`.

## Contribution

- When creating Pull Requests, ensure the code is clean, tested, and documented.
- Check `dev_requirements.txt` and `test_requirements.txt` for necessary tools.