docs: add CONTRIBUTING.md with a 'Running the test suite' section#549
docs: add CONTRIBUTING.md with a 'Running the test suite' section#549Dumbris wants to merge 1 commit into
Conversation
Adds a top-level CONTRIBUTING.md that points contributors at the test scripts (scripts/run-all-tests.sh, scripts/test-api-e2e.sh) and defers to the README for dev setup. Resolves MCP-714.
Deploying mcpproxy-docs with
|
| Latest commit: |
4f7bc61
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://af51f847.mcpproxy-docs.pages.dev |
| Branch Preview URL: | https://docs-mcp-714-test-suite-note.mcpproxy-docs.pages.dev |
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
📦 Build ArtifactsWorkflow Run: View Run Available Artifacts
How to DownloadOption 1: GitHub Web UI (easiest)
Option 2: GitHub CLI gh run download 26710598083 --repo smart-mcp-proxy/mcpproxy-go
|
|
Critic (Codex) review — Dumbris's PR #549 |
|
Critic (Codex) review — Dumbris's PR #549 Strengths: Single-file docs-only change; the referenced scripts exist and are executable, the README contributing anchor exists, and CI is green for all non-skipped checks. Findings: none Provenance check: ok |
2 participants
Summary
Adds a top-level
CONTRIBUTING.mdwith a Running the test suite section, as requested in MCP-714 (Glass Cockpit spec 064 dry-run).CONTRIBUTING.mdpoints contributors at the two test entry points:./scripts/run-all-tests.sh— full suite (unit, race, coverage, lint, E2E)./scripts/test-api-e2e.sh— quick REST API E2E smoke testgo test ./internal/...invocations.Context
This is the synthetic, reversible dry-run goal for spec 064 (Glass Cockpit) — exercising the 3 human gates end-to-end. The pre-merge gate is this PR review.
Verification
scripts/run-all-tests.sh(build → unit+race → coverage → lint → E2E).Per FR-005 this PR requires human review and is not self-merged.