[diff-contract] Add pre-commit hook integration

Open Beginner friendly
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
84/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
git, python
Domain
developer-experience, tooling

Research direction

Start with the diff-contract validate CLI entry point and the project's existing documentation entry points. Add .pre-commit-hooks.yaml, document pip install diff-contract && pre-commit install, and verify that the hook runs diff-contract validate on staged files.

Written by the indexing model from the issue text.

Description

enhancement good first issue

Context

diff-contract supports CI (GitHub Actions) and manual runs. A pre-commit hook would catch contract violations before they leave the developer's machine.

Acceptance Criteria

  • .pre-commit-hooks.yaml for the pre-commit framework
  • Document setup: pip install diff-contract && pre-commit install
  • Hook runs diff-contract validate on staged files
Dominant language
Python
Stars
1
Forks
3
Avg merge
8h 23m
Merged PRs (30d)
5

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from yunaremaia/diff-contract

All issues in yunaremaia/diff-contract

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.