Skip to content

Add Pre-commit Configuration Page to Data Handbook #12

Description

@simonprydden

User Story:

As a data engineer,
I want a dedicated page in the data handbook that outlines the recommended pre-commit configuration,
so that I can easily set up a consistent and standardized development environment, which promotes code quality and reduces integration issues.

Acceptance Criteria:

  • A new page named "Pre-commit Configuration" exists in the data handbook.
  • The page clearly explains the purpose of pre-commit hooks for data projects.
  • The page lists the recommended pre-commit hooks for our project (e.g., black, flake8, isort, mypy).
  • The page provides example .pre-commit-config.yaml content, reflecting the recommended hooks and settings.
  • The page includes clear instructions on how to install and enable pre-commit hooks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions