Skip to content

docs: add pre-commit install guide on CONTRIBUTING.md #995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dingo4dev
Copy link

Summary

CONTRIBUTING.md

  • Added instructions for setting up pre-commit hooks using the uv tool install pre-commit
  • Added an optional step to run pre-commit hooks on all files using the pre-commit run --all-files command.

Motivation and Context

To enhance the development setup and workflow instructions. The changes include adding steps for setting up and running pre-commit hooks.

Types of changes

  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

@Copilot Copilot AI review requested due to automatic review settings June 20, 2025 16:59
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds documentation steps for setting up and running pre-commit hooks in the CONTRIBUTING guide

  • Introduces a new step for installing pre-commit via the uv tool
  • Adds an optional step to run all pre-commit hooks across the codebase
Comments suppressed due to low confidence (1)

CONTRIBUTING.md:54

  • [nitpick] The list numbering is now duplicated because of the inserted steps. Consider updating this to '8.' or using Markdown's auto-numbering (all '1.') to keep the sequence correct without manual renumbering.
7. Submit a pull request to the same branch you branched from

@dingo4dev dingo4dev changed the title docs: add pre-commit docs: add pre-commit install guide on CONTRIBUTING.md Jun 20, 2025
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.

1 participant