|
| 1 | +# meetup_bot Project Reference |
| 2 | + |
| 3 | +## General Instructions |
| 4 | + |
| 5 | +- Minimize inline comments |
| 6 | +- Retain tabs, spaces, and encoding |
| 7 | +- Fix linting errors before saving files. |
| 8 | + - Respect `.markdownlint.jsonc` rules for all markdown files |
| 9 | +- If under 50 lines of code (LOC), print the full function or class |
| 10 | +- If the token limit is close or it's over 50 LOC, print the line numbers and avoid comments altogether |
| 11 | +- Explain as much as possible in the chat unless asked to annotate (i.e., docstrings, newline comments, etc.) |
| 12 | + |
| 13 | +## Build, Lint, and Test Commands |
| 14 | + |
| 15 | +- Full test suite: `uv run pytest` or `task test` |
| 16 | +- Single test: `uv run pytest tests/test_filename.py::test_function_name` |
| 17 | +- Linting: `uv run ruff check --fix --respect-gitignore` or `task lint` |
| 18 | +- Formatting: `uv run ruff format --respect-gitignore` or `task format` |
| 19 | +- Check dependencies: `uv run deptry .` or `task deptry` |
| 20 | +- Pre-commit hooks: `pre-commit run --all-files` or `task pre-commit` |
| 21 | + |
| 22 | +## Code Style Guidelines |
| 23 | + |
| 24 | +- **Formatting**: 4 spaces, 130-char line limit, LF line endings |
| 25 | +- **Imports**: Ordered by type, combined imports when possible |
| 26 | +- **Naming**: snake_case functions/vars, PascalCase classes, UPPERCASE constants |
| 27 | +- **Type Hints**: Use Optional for nullable params, pipe syntax for Union |
| 28 | +- **Error Handling**: Specific exception types, descriptive error messages |
| 29 | +- **File Structure**: Core logic in app/core/, utilities in app/utils/ |
| 30 | +- **Docstrings**: Use double quotes for docstrings |
| 31 | +- **Tests**: Files in tests/, follow test_* naming convention |
0 commit comments