Skip to content

Add code quality and linting guidelines to AGENTS.md #572

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

Merged
juanitorduz merged 1 commit into from
Nov 24, 2025
Merged

Add code quality and linting guidelines to AGENTS.md #572

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
9 changes: 9 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@
- **Custom exceptions**: Use project-specific exceptions from `causalpy.custom_exceptions`: `FormulaException`, `DataException`, `BadIndexException`
- **File organization**: Experiments in `causalpy/experiments/`, PyMC models in `causalpy/pymc_models.py`, scikit-learn models in `causalpy/skl_models.py`

## Code quality checks

- **Before committing**: Always run `pre-commit run --all-files` to ensure all checks pass (linting, formatting, type checking)
- **Quick check**: Run `ruff check causalpy/` for fast linting feedback during development
- **Auto-fix**: Run `ruff check --fix causalpy/` to automatically fix many linting issues
- **Format**: Run `ruff format causalpy/` to format code according to project standards
- **Linting rules**: Project uses strict linting (F, B, UP, C4, SIM, I) to catch bugs and enforce modern Python patterns
- **Note**: Documentation notebooks in `docs/` are excluded from strict linting rules

## Type Checking

- **Tool**: MyPy
Expand Down