Skip to content

docs: add bounty evidence templates#433

Merged
ramimbo merged 2 commits into
ramimbo:mainfrom
prettyboyvic:codex/bounty-426-evidence-templates
May 26, 2026
Merged

docs: add bounty evidence templates#433
ramimbo merged 2 commits into
ramimbo:mainfrom
prettyboyvic:codex/bounty-426-evidence-templates

Conversation

@prettyboyvic
Copy link
Copy Markdown
Contributor

@prettyboyvic prettyboyvic commented May 26, 2026

Summary

  • Add reusable evidence templates for PR/fix claims, review claims, smoke reports, and decision-support claims in docs/bounty-rules.md.
  • Extend scripts/docs_smoke.py so the new evidence-template section remains covered by docs smoke checks.

Refs #426

Evidence

  • Compared against current bounty rules and recent review/smoke/discussion bounty formats.
  • Intended files or surfaces: docs/bounty-rules.md, scripts/docs_smoke.py.
  • Expected PR size: small docs + docs smoke guard.
  • Out of scope: API/MCP examples, attempt-auth docs, payout mechanics, price/off-ramp claims.

Test Evidence

  • ./.venv/Scripts/python.exe scripts/docs_smoke.py -> docs smoke ok
  • ./.venv/Scripts/python.exe -m ruff check scripts/docs_smoke.py -> passed
  • ./.venv/Scripts/python.exe -m ruff format --check scripts/docs_smoke.py -> passed
  • git diff --check -> clean

MRWK

Related bounty or issue (Bounty #N or Refs #N for multi-award bounties): Refs #426

Summary by CodeRabbit

  • Documentation

    • Added a "Submission Evidence Templates" section with three template formats (PR/fix, review, smoke-check/bug-report) and guidance to choose the smallest suitable template.
    • Added instruction not to describe work as accepted/merged/paid until a public label, maintainer comment, or specified proof is present.
  • Tests

    • Extended smoke-test validation to require the new heading text, prompt lines, and the explicit constraint about describing work status.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: bf0dfb86-b8a3-4852-9430-535300d123a4

📥 Commits

Reviewing files that changed from the base of the PR and between 54a56fc and fbe0749.

📒 Files selected for processing (1)
  • scripts/docs_smoke.py

📝 Walkthrough

Walkthrough

Documentation adds three structured evidence template formats (PR/fix, review, smoke-check/bug-report) for bounty submissions, with guidance on selecting the smallest suitable template and a rule against describing work as accepted/merged/paid until public GitHub labels or MRWK proofs exist. Smoke test validation is extended to ensure template content remains present.

Changes

Bounty submission templates and validation

Layer / File(s) Summary
Submission Evidence Templates documentation and smoke test
docs/bounty-rules.md, scripts/docs_smoke.py
New "Submission Evidence Templates" section defines three template variants (PR/fix, review, smoke-check/bug-report) with guidance on selecting the minimal suitable format. Adds rule forbidding "accepted/merged/paid" language until public GitHub label, maintainer comment, or MRWK proof exists. Smoke test extended to validate template section headings and phrasing remain in the rules document.

Possibly related PRs

  • ramimbo/mergework#392: Both PRs update docs/bounty-rules.md and extend scripts/docs_smoke.py to enforce specific public phrasing requirements for bounty submission content.
  • ramimbo/mergework#413: Adds Markdown reporting formatter that parallels the new "Submission Evidence Templates" phrasing checks in the smoke test validation logic.
🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add bounty evidence templates' clearly and concretely names the changed surface (docs/bounty-rules.md) and the primary addition (evidence templates).
Description check ✅ Passed The description includes all required sections (Summary, Evidence, Test Evidence, MRWK) with specific details about changes, scope boundaries, and test results confirming successful validation.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Mergework Public Artifact Hygiene ✅ Passed PR adds evidence templates and prevents premature claim wording; no investment, price, cash-out claims or unredacted security details found; docs_smoke validates against banned phrases.
Bounty Pr Focus ✅ Passed PR #433 changes match stated bounty files (docs/bounty-rules.md, scripts/docs_smoke.py), include evidence and passing test validation, and avoid unrelated scope creep.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@aiautotool aiautotool left a comment

Choose a reason for hiding this comment

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

Reviewed PR #433 against current origin/main. The change is focused on docs: it adds submission evidence templates to docs/bounty-rules.md and extends scripts/docs_smoke.py so the new section remains covered.

I checked the templates against the current bounty workflows in docs/bounty-rules.md, the PR template, and recent issue comment patterns. The fields cover the main accepted submission shapes without implying acceptance, merge, payment, price, bridge, or off-ramp behavior. The smoke-check addition is also narrow and verifies the new headings/labels without making docs smoke brittle around the exact template body.

Local verification on head 54a56fcb23a766878d74fde6cd24e933b47953c9:

  • python scripts/docs_smoke.py -> docs smoke ok
  • python -m pytest tests/test_docs_public_urls.py -q -> 18 passed
  • python -m ruff check scripts/docs_smoke.py -> passed
  • python -m ruff format --check scripts/docs_smoke.py -> passed
  • git diff --check origin/main...HEAD -> passed

No blocking issues found from my review.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 7c878496-7289-4280-830a-864971e45960

📥 Commits

Reviewing files that changed from the base of the PR and between 764e9ed and 54a56fc.

📒 Files selected for processing (2)
  • docs/bounty-rules.md
  • scripts/docs_smoke.py

Comment thread scripts/docs_smoke.py
@ramimbo ramimbo merged commit d68062b into ramimbo:main May 26, 2026
2 checks passed
@ramimbo ramimbo added mrwk:accepted Maintainer accepted for payout mrwk:paid Ledger payment recorded labels May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mrwk:accepted Maintainer accepted for payout mrwk:paid Ledger payment recorded

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants