Skip to content

Add pre-commit configuration and update contributing guidelines#90

Merged
chrisdedman merged 4 commits into
mainfrom
pre-commit-init
Jul 4, 2026
Merged

Add pre-commit configuration and update contributing guidelines#90
chrisdedman merged 4 commits into
mainfrom
pre-commit-init

Conversation

@chrisdedman

@chrisdedman chrisdedman commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Description

Introduce pre-commit hooks to enforce code quality and update contributing guidelines to include installation instructions for development dependencies.

Type of Change

  • Feature
  • Refactor
  • Bug fix
  • Documentation
  • Other: pre-commit setup

Pre-merge Checklist

  • Run tests: pytest
  • Run type check: mypy
  • Run formatting: black .

@chrisdedman chrisdedman added the feature A new feature label Jul 4, 2026
@chrisdedman chrisdedman requested a review from PenguinBoi12 July 4, 2026 02:53
@chrisdedman chrisdedman self-assigned this Jul 4, 2026

@PenguinBoi12 PenguinBoi12 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like the idea of integrating this, it could make this much easier to prevent pushing code that isn't formatted and tested.

I think for now it's fine to make people run the command but maybe eventually we could consider something like a make file to install the project as dev.

I feel like with that and a future proper (in another PR) dev documentation could make contributing and reviewing much easier.

Comment thread .pre-commit-config.yaml Outdated
Comment thread .pre-commit-config.yaml Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@chrisdedman chrisdedman requested a review from PenguinBoi12 July 4, 2026 23:15

@PenguinBoi12 PenguinBoi12 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 🦭

It's going to make dev easier good idea.

@chrisdedman chrisdedman merged commit 19f4fa4 into main Jul 4, 2026
4 checks passed
@chrisdedman chrisdedman deleted the pre-commit-init branch July 4, 2026 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature A new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants