30 lines (25 loc) · 899 Bytes

actions-graph — Project Conventions

Structure

src/actions_graph/ — main package
tests/ — pytest tests mirroring src structure
Python 3.10+ — use from __future__ import annotations in all modules

Code Style

Ruff for linting and formatting (line-length=99)
Type hints on all public functions
Docstrings on public classes and functions (one-line where possible)
No star imports; explicit imports only
Use pathlib.Path over os.path

Commit Format

feat: new features
fix: bug fixes
test: test additions/changes
docs: documentation
refactor: code restructuring
chore: tooling, deps, config

Testing

uv run pytest to run tests
uv run pytest --cov=actions_graph for coverage
Test files named test_<module>.py
Use fixtures and tmp_path for file-based tests

Linting

uv run ruff check . and uv run ruff format .