Skip to content

feat: add pre-commit configuration and contributing guide - #160

Merged
codeforstartups merged 1 commit into
codeforstartups:developmentfrom
Ashishds:feat/pre-commit-config
Sep 8, 2026
Merged

codeforstartups merged 1 commit into
codeforstartups:developmentfrom
Ashishds:feat/pre-commit-config

Conversation

@Ashishds

@Ashishds Ashishds commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Closes #113

Summary of Changes

  • Added .pre-commit-config.yaml configured with:
    • ruff and ruff-format
    • Standard hygiene hooks (trailing-whitespace, end-of-file-fixer, check-yaml, check-toml)
  • Added pre-commit to the dev extra in pyproject.toml.
  • Added a comprehensive CONTRIBUTING.md guide covering:
    • Local setup (clone, virtual environment, editable install)
    • Installing and running pre-commit hooks
    • Running test suite and linter checks (ruff, pytest)
    • Branching and Conventional Commits PR guidelines
  • Formatted test files to ensure full compliance with newly introduced hooks.

Local Verification

  • Verified pre-commit run --all-files passes cleanly across all tracked files.
  • Ran full test suite: pytest passed (127 passed, 2 skipped).
  • Ran linter: ruff check src benchmarks tests passed with zero errors.

@codeforstartups codeforstartups left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified (tests + ruff green). pre-commit + CONTRIBUTING with no broken CI job — supersedes #117. Thanks @Ashishds!

@codeforstartups
codeforstartups merged commit 78ebc95 into codeforstartups:development Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a pre-commit config

2 participants