Add AGENTS guidelines

This commit is contained in:
Christian Krakau-Louis
2025-05-27 22:40:41 +02:00
parent 494ca5adde
commit 8fc3b38c77
+22
View File
@@ -0,0 +1,22 @@
# AGENTS Instructions for Quizzical Beats
These instructions apply to the entire repository.
## Development Guidelines
- Follow **PEP 8** with a maximum line length of **100 characters**.
- Use **4 spaces** for indentation. Tabs are not allowed.
- Provide docstrings for all functions and classes using Google's style guide.
- Keep Flask routes organized using blueprints and prefer class-based views for complex endpoints.
## Commit Messages
- Write clear, concise commit messages in English.
- Reference related issues when applicable.
## Testing
- Run `pytest` before committing changes. If tests fail due to missing
dependencies or external services, mention this in the PR.
## Pull Request
- Summarize major changes and reference relevant documentation updates.
- Include test results in the PR description.