Skip to content

docs: add CONTRIBUTING.md with a 'Running the test suite' section#549

Merged
Dumbris merged 1 commit into
mainfrom
docs/mcp-714-test-suite-note
Jun 10, 2026
Merged

docs: add CONTRIBUTING.md with a 'Running the test suite' section#549
Dumbris merged 1 commit into
mainfrom
docs/mcp-714-test-suite-note

Conversation

@Dumbris

@Dumbris Dumbris commented May 31, 2026

Copy link
Copy Markdown
Member

Summary

Adds a top-level CONTRIBUTING.md with a Running the test suite section, as requested in MCP-714 (Glass Cockpit spec 064 dry-run).

  • New CONTRIBUTING.md points 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 test
  • Defers to the README's Contributing section for dev setup / pre-commit hooks (no duplication).
  • Also notes the direct go 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

  • Confirmed both referenced scripts exist and are executable.
  • Verified the described stages match scripts/run-all-tests.sh (build → unit+race → coverage → lint → E2E).
  • Docs-only change; no Go code touched.

Per FR-005 this PR requires human review and is not self-merged.

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.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying mcpproxy-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions

github-actions Bot commented May 31, 2026

Copy link
Copy Markdown

📦 Build Artifacts

Workflow Run: View Run
Branch: docs/mcp-714-test-suite-note

Available Artifacts

  • archive-darwin-amd64 (28 MB)
  • archive-darwin-arm64 (25 MB)
  • archive-linux-amd64 (16 MB)
  • archive-linux-arm64 (14 MB)
  • archive-windows-amd64 (28 MB)
  • archive-windows-arm64 (24 MB)
  • frontend-dist-pr (0 MB)
  • installer-dmg-darwin-amd64 (21 MB)
  • installer-dmg-darwin-arm64 (19 MB)

How to Download

Option 1: GitHub Web UI (easiest)

  1. Go to the workflow run page linked above
  2. Scroll to the bottom "Artifacts" section
  3. Click on the artifact you want to download

Option 2: GitHub CLI

gh run download 27188547393 --repo smart-mcp-proxy/mcpproxy-go

Note: Artifacts expire in 14 days.

@Dumbris

Dumbris commented Jun 1, 2026

Copy link
Copy Markdown
Member Author

Critic (Codex) review — Dumbris's PR #549
Verdict: accept
Strengths: The new CONTRIBUTING.md is narrowly scoped to contributor test guidance, references existing scripts (scripts/run-all-tests.sh, scripts/test-api-e2e.sh) that are present in the repo, and all checks are green at head 4f7bc612b64e0f5b752d14c1cf6329f68a935112.
Findings: none.
Provenance check: ok

@Dumbris

Dumbris commented Jun 1, 2026

Copy link
Copy Markdown
Member Author

Critic (Codex) review — Dumbris's PR #549
Verdict: accept
Head: 4f7bc612b64e0f5b752d14c1cf6329f68a935112

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

@mcpproxy-gatekeeper mcpproxy-gatekeeper Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Gatekeeper approval — Codex review verdict: ACCEPT.

This approval is posted automatically by the MCPProxy Gatekeeper App on behalf of the Codex reviewer (verdict of record lives in the Paperclip review thread). Author≠approver satisfied; QA + CI gates enforced separately.

Auto-approved per Model B (MCP-1249).

@Dumbris Dumbris closed this Jun 9, 2026
@Dumbris Dumbris reopened this Jun 9, 2026
@Dumbris Dumbris merged commit d0f9ab6 into main Jun 10, 2026
60 checks passed
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.

2 participants