Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (27 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.73 KB
Raw

Contributing to MCPProxy

Thanks for your interest in improving MCPProxy! We welcome issues, feature ideas, and pull requests.

For development setup, pre-commit hooks, and the build/test make targets, see the Contributing section in the README.

Running the test suite

Before opening a pull request, run the test suite locally. Build the binary first (make build), since the end-to-end tests drive the compiled mcpproxy.

./scripts/run-all-tests.sh     # Full suite: unit, race, E2E, and coverage
./scripts/test-api-e2e.sh      # Quick REST API end-to-end smoke test
  • scripts/run-all-tests.sh runs the complete suite — unit tests, race detection, and the API E2E stage — and writes a coverage report. Use this for a thorough check before merging.
  • scripts/test-api-e2e.sh stands up a local mcpproxy instance and exercises the /api/v1 REST endpoints. It's faster and is the minimum check for any change that touches the server or API.

You can also run the Go tests directly:

go test ./internal/... -v          # Unit tests
go test -race ./internal/... -v    # With the race detector

See CLAUDE.md and the docs for the full development and testing reference.

Recognition

When your pull request is merged, a bot comments with a thank-you and a short snippet you can copy if you would like to mention it. Sharing is entirely optional; it does help a small open-source project get found. Contributors from outside the maintainer team are also credited in a "Contributors" section of the release notes. The logic lives in scripts/contributors.sh (tests: scripts/test-contributors.sh) and .github/workflows/contributor-thanks.yml.