Adding CONTRIBUTING.md and pre-commit hook

[jpchauvel]

• adding CONTRIBUTING.md and pre-commit hook, fixess Write a CONTRIBUTING.md #44
• bump version to 0.2.3

Summary by CodeRabbit

• Documentation

  • Added a comprehensive CONTRIBUTING guide with setup, testing, and contribution steps.

• Chores

  • Bumped version to 0.2.3.
  • Added pre-commit to development dependencies.
  • Introduced pre-commit hooks to run tests during pre-commit and pre-push.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds pre-commit tooling and documentation. Introduces .pre-commit-config.yaml with a local “testing” hook running ./bin/test.sh on pre-commit and pre-push. Updates pyproject.toml to version 0.2.3 and adds pre-commit to dev dependencies. Adds CONTRIBUTING.md with contributor workflow and commands.

Changes

Cohort / File(s)	Summary
Pre-commit setup ./.pre-commit-config.yaml	New pre-commit config with a local hook (id: testing) running ./bin/test.sh, language: python, default_stages: [pre-commit, pre-push].
Packaging & versioning ./pyproject.toml	Bumps version 0.2.2 → 0.2.3; adds pre-commit>=4.3.0 to the dev dependency group.
Contributor documentation ./CONTRIBUTING.md	New developer guide: setup with uv, installing hooks, running tests/coverage, handling failures, bumping version, and opening PRs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I thump my paw, pre-commit in tow,
Hooks at the ready—tests all aglow.
Version hops lightly: two-dot-three!
Docs like carrots, crisp and free.
With every push and gentle nudge,
This bunny approves—no flakes, no fudge. 🥕🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 38746e0 and 27805fc.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (3)

• .pre-commit-config.yaml (1 hunks)
• CONTRIBUTING.md (1 hunks)
• pyproject.toml (2 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch issue-44

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.