Skip to content

Add expected PR size bounty guidance [Bounty #383]#392

Open
prettyboyvic wants to merge 2 commits into
ramimbo:mainfrom
prettyboyvic:codex/bounty-383-size-prompt
Open

Add expected PR size bounty guidance [Bounty #383]#392
prettyboyvic wants to merge 2 commits into
ramimbo:mainfrom
prettyboyvic:codex/bounty-383-size-prompt

Conversation

@prettyboyvic
Copy link
Copy Markdown
Contributor

@prettyboyvic prettyboyvic commented May 26, 2026

Summary

  • Add an explicit Expected PR size: prompt to the pull request template.
  • Align the agent guide and bounty rules around the same claim-window packet: exact bounty, intended files/surfaces, expected PR size, test plan, evidence, and out-of-scope notes.
  • Extend scripts/docs_smoke.py so the expected-size prompt is checked before future docs/template changes pass smoke.

Evidence

Test Evidence

  • uv run --extra dev python -m ruff check . -> passed.
  • uv run --extra dev python -m ruff format --check . -> 65 files already formatted.
  • uv run --extra dev python scripts/docs_smoke.py -> docs smoke ok.
  • uv run --extra dev python -m pytest tests/test_docs_public_urls.py tests/test_check_agents.py tests/test_submission_quality_gate.py -q -> 41 passed.
  • uv run --extra dev python -m mypy app -> success.
  • uv run --extra dev python -m pytest -q -> 377 passed.
  • git diff --check -> clean.

MRWK

Bounty #383

No private keys, seed material, secrets, deployment credentials, private vulnerability details, payout credentials, or MRWK price claims are included.

Summary by CodeRabbit

  • Documentation

    • Updated agent guide and bounty rules with a new bounty PR submission step requiring a written claim-window scope before coding
    • Introduced a "claim-window packet" format for PRs: bounty reference, intended files/surfaces, expected PR size, test plan, evidence, and out-of-scope items
    • Reordered checklist for clarity
  • Chores

    • Added validation to enforce the new PR template requirements (including expected PR size)

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: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ca6b6429-fe25-4cc2-973d-d80879ef4388

📥 Commits

Reviewing files that changed from the base of the PR and between 0ca1bd4 and 910f01b.

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

📝 Walkthrough

Walkthrough

This PR requires contributors to declare claim-window scope in PRs (exact bounty reference, intended files/surfaces, expected PR size, test plan, out-of-scope) via updated PR template, agent guide, and bounty rules, and adds a docs_smoke.py check to validate the template contains "expected pr size:".

Changes

Bounty Scope Documentation and Validation

Layer / File(s) Summary
Bounty scope documentation
.github/pull_request_template.md, docs/bounty-rules.md, docs/agent-guide.md
PR template checklist adds prompts for bounty capacity/active attempts, intended files/surfaces, expected PR size, and out-of-scope items; docs/bounty-rules.md documents the required claim-window packet in PR bodies; docs/agent-guide.md adds a checklist step to write scope before coding and renumbers subsequent steps.
PR template validation in smoke tests
scripts/docs_smoke.py
Adds PR_TEMPLATE constant referencing the template path and updates main() to fail the docs smoke check if .github/pull_request_template.md is missing or does not contain the case-insensitive prompt "expected pr size:".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

Suggested labels

mrwk:accepted

Suggested reviewers

  • weilixiong
  • tolga-tom-nook
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: adding explicit PR size guidance to bounty-related documentation and checks.
Description check ✅ Passed The description comprehensively covers all required template sections including summary, evidence, detailed test results, and MRWK bounty reference with security note.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@scripts/docs_smoke.py`:
- Around line 67-74: The PR-template check is currently guarded by "if ok:" so
it is skipped when earlier checks fail; remove that conditional and run the
block unconditionally while keeping the existing checks that set the "ok" flag
(referencing pr_template, ROOT, PR_TEMPLATE, and ok) so template existence and
"expected pr size:" content are always validated and failures still aggregate by
setting ok = False when checks fail.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d2eaf4d3-3570-4af5-ab90-16dea5d991e7

📥 Commits

Reviewing files that changed from the base of the PR and between a1795ed and 0ca1bd4.

📒 Files selected for processing (4)
  • .github/pull_request_template.md
  • docs/agent-guide.md
  • docs/bounty-rules.md
  • scripts/docs_smoke.py

Comment thread scripts/docs_smoke.py Outdated
Copy link
Copy Markdown
Contributor

@tolga-tom-nook tolga-tom-nook left a comment

Choose a reason for hiding this comment

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

Manual review pass for bounty #340 on PR #392 at head 910f01b.

Evidence checked:

  • Inspected .github/pull_request_template.md, docs/agent-guide.md, docs/bounty-rules.md, and scripts/docs_smoke.py.
  • Verified the docs/template additions stay focused on claim-window scope, expected PR size, evidence, and out-of-scope notes for bounty submissions.
  • Ran ./.venv/bin/python scripts/docs_smoke.py -> docs smoke ok.
  • Ran ./.venv/bin/python -m ruff check scripts/docs_smoke.py -> passed.

I do not see a blocking issue in the docs behavior. The ruff format --check command is not meaningful for the Markdown files without Ruff preview mode, but the Python smoke script itself is clean.

Copy link
Copy Markdown
Contributor

@ayskobtw-lil ayskobtw-lil left a comment

Choose a reason for hiding this comment

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

No blockers from my follow-up review on current head 910f01b.

Evidence checked:

  • Inspected .github/pull_request_template.md, docs/agent-guide.md, docs/bounty-rules.md, and scripts/docs_smoke.py against Bounty #383.
  • Verified the PR template now has explicit claim-window fields for bounty capacity/open PR checks, intended files/surfaces, expected PR size, and out-of-scope notes.
  • Verified the agent guide and bounty rules describe the same claim-window packet: exact bounty, intended surfaces, expected size, test plan, evidence, and out-of-scope notes.
  • Verified the second commit addresses CodeRabbit's docs-smoke nit: the PR-template check now runs even if earlier docs checks have already set ok = False, so missing Expected PR size: cannot be masked by an earlier failure.
  • Checked that scope is limited to docs/template/docs-smoke behavior and does not add payout, price, bridge, cash-out, runtime, API, ledger, wallet, or MCP claims.
  • Hosted quality check was green in the PR metadata I inspected.

Local validation:

  • python scripts/docs_smoke.py -> docs smoke ok
  • python -m pytest tests/test_docs_public_urls.py tests/test_submission_quality_gate.py -q -> 39 passed
  • python -m ruff check scripts/docs_smoke.py -> passed
  • python -m ruff format --check scripts/docs_smoke.py -> 1 file already formatted
  • python -m mypy scripts/docs_smoke.py -> success
  • git diff --check origin/main...HEAD -> clean

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.

3 participants