docs: add maintainer bounty post template#462
Conversation
📝 WalkthroughWalkthroughThis PR standardizes the bounty request process by updating the GitHub issue template with new form fields, documenting a consistent bounty post template in the bounty rules, updating the admin runbook with clear posting steps, and adding smoke test validation to ensure the template and documentation remain synchronized. ChangesBounty Template Standardization
Possibly related issues
Possibly related PRs
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 8b010afd-adfd-42e0-b14f-f6c8d6509e98
📒 Files selected for processing (4)
.github/ISSUE_TEMPLATE/bounty.ymldocs/admin-runbook.mddocs/bounty-rules.mdscripts/docs_smoke.py
| else: | ||
| bounty_template = bounty_issue_template.read_text(encoding="utf-8").lower() | ||
| for phrase in [ | ||
| "mrwk bounty: <amount> mrwk -", |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
Strengthen heading validation to require the full stable title pattern.
The check currently accepts mrwk bounty: <amount> mrwk - alone, so CI won’t catch regressions that drop <short scope>. Require the full phrase to enforce the documented contract.
Proposed diff
- "mrwk bounty: <amount> mrwk -",
+ "mrwk bounty: <amount> mrwk - <short scope>",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "mrwk bounty: <amount> mrwk -", | |
| "mrwk bounty: <amount> mrwk - <short scope>", |
Summary
docs/bounty-rules.md..github/ISSUE_TEMPLATE/bounty.ymlwith the same evidence, out-of-scope, duplicate/stale, and public artifact hygiene prompts, then guard the headings in docs smoke.Refs #456
Evidence
docs/bounty-rules.mdalready has contributor submission evidence templates from merged PR docs: add bounty evidence templates #433, but it did not document a maintainer-facing bounty post template.docs/admin-runbook.mdonly had a short "Post a Bounty" checklist without stable heading or amount-in-title guidance..github/ISSUE_TEMPLATE/bounty.ymlused the title prefix[bounty]and required only work, reward, max awards, and acceptance fields.[].agent-friendly bounty post template,bounty post template,stable headings, andamount-in-titlefound no same-scope open PR or claim. Adjacent PR docs: document bounty sort and limit filters #457 is MRWK bounty: documentation updates and improvements #426 API docs, and owner draft PR add treasury governance proposals #458 is governance proposal work, not this template.Validation
uv run --extra dev python scripts/docs_smoke.py-> docs smoke okuv run --extra dev python -m pytest tests/test_docs_public_urls.py -q-> 22 passeduv run --extra dev ruff check scripts/docs_smoke.py-> passeduv run --extra dev ruff format --check scripts/docs_smoke.py-> already formatteduv run --extra dev ruff check .-> passeduv run --extra dev ruff format --check .-> 79 files already formatteduv run --extra dev python -m mypy app-> successuv run --extra dev python -m pytest -q-> 413 passedgit diff --check-> cleangitleaks detect --pipe --redact --no-banner --no-color --exit-code 1-> no leaks foundMRWK
Related bounty or issue (
Bounty #NorRefs #Nfor multi-award bounties): Refs #456No private keys, seed material, credentials, private vulnerability details, deployment secrets, price claims, investment claims, liquidity claims, exchange claims, bridge promises, off-ramp promises, or fabricated payout claims are included.
Summary by CodeRabbit
Release Notes
Documentation
Chores