pavlo-kostyshyn/documentationrules icon
public
Published on 6/3/2025
Documentation Rules

Rules

Documentation Guidelines

  • Use docstrings on all public-facing functions and classes. - Annotate every FastAPI route with response_model. - Update README.md with project setup, development, and deployment steps. - Maintain CHANGELOG.md with meaningful version summaries. - Write meaningful descriptions for Alembic migrations. - Comment only non-obvious logic (avoid cluttering with "trivial" comments).