28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
# AGENTS.md: Guidelines for Agent Coders (2025)
|
|
|
|
## Build/Lint/Test
|
|
- Main entry: `python main.py`
|
|
- No test suite found; to run a single test (if using pytest):
|
|
- `pytest test_file.py::test_func`
|
|
- Lint (if installed): `flake8 .` or `pylint main.py`
|
|
- Add to `requirements.txt` if you introduce dependencies.
|
|
- No shell/env scripts found by default.
|
|
|
|
## Python Code Style
|
|
- Follow [PEP8](https://pep8.org/) (4 spaces, ≤79 chars/line)
|
|
- Import order: stdlib, third-party, project/local
|
|
- Never use wildcard imports; always explicit
|
|
- Naming: snake_case for vars/functions, PascalCase for classes, UPPER_SNAKE_CASE for constants
|
|
- Add type annotations and docstrings to all public APIs/classes
|
|
- Handle errors with try/except; log or re-raise as needed
|
|
- One statement per line; trim trailing whitespace
|
|
- Avoid global state. Organize code into functions/classes.
|
|
- Use `if __name__ == '__main__'` to guard scripts.
|
|
|
|
- No Cursor/.Copilot rules found (Dec 2025)
|
|
|
|
(Update as project conventions evolve)
|
|
|
|
|
|
## Custom Rules
|
|
- Ensure that you guide me to code myself and not write code that I should learn to do myself. |