Skip to content

Add pre-commit hooks guide to documentation #4

Description

@kashifpk

Description

Add documentation on how to set up pre-commit hooks across the Agentic Forge repositories to catch CI issues before pushing.

Background

Recent commits to mcp-weather and mcp-web-search caused CI failures that could have been caught locally with pre-commit hooks.

Tasks

  • Document the pre-commit setup process for Python repos
  • Add a section to GETTING_STARTED.md about running checks before committing
  • Consider adding a script to install pre-commit hooks across all repos

Example Commands

# For Python repos (mcp-weather, mcp-web-search, forge-armory, forge-orchestrator)
cd <repo>
uv run pre-commit install
uv run pre-commit run --all-files

# Or manually run checks
uv run ruff check .
uv run basedpyright
uv run pytest

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions