docs: add claim window and evidence guidelines (Bounty #383)#399
docs: add claim window and evidence guidelines (Bounty #383)#399Karry2019web wants to merge 2 commits into
Conversation
Align contributor guidance with discussion ramimbo#128 claim-window expectations: docs/bounty-rules.md: - Add "Claim Window and Award Capacity" section — explains how to check remaining slots, count /claim comments, and avoid oversubscribed rounds. - Add "Evidence Guidelines for Claims" reference table — clarifies what evidence is required for PRs, reviews, docs, and bug reports. docs/agent-guide.md: - Add "Claim Window Etiquette" section to Bounty Submission Checklist — covers capacity checking, one-PR-per-slot rule, and evidence in PR bodies. Related: Bounty ramimbo#383
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation formalizes claim window and award-capacity policies and adds evidence requirements; agent-facing etiquette guidance for validating capacity and including evidence in multi-award bounty PRs is added. ChangesClaim Window and Evidence Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related issues
Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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 `@docs/bounty-rules.md`:
- Line 66: The rule currently compares pending claims to max_awards; change it
to compare pending claims to remaining slots by computing remaining_slots =
max_awards - awarded_count (where awarded_count includes prior accepted and paid
awards) and then use "If pending claims >= remaining_slots, the bounty is
oversubscribed and new PRs may not get a slot." Update the text to reference
remaining_slots (or an equivalent term used elsewhere like available_slots) and
ensure awarded_count is clearly defined as prior accepted/paid awards.
🪄 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: f6ecb1fc-9d14-4598-b32d-15d1a4c62679
📒 Files selected for processing (2)
docs/agent-guide.mddocs/bounty-rules.md
Zejia
left a comment
There was a problem hiding this comment.
I would fix one capacity-accounting detail before merging this.
The new guidance in docs/bounty-rules.md says to count /claim comments and then treat pending claims >= max_awards as oversubscribed. That is only correct before any awards have been accepted or paid. Once a round is partially paid, the check needs to compare pending claims against remaining slots, not the original cap.
Concrete example from the current Bounty #383 thread: max_awards = 2, PR #387 has already been paid, and there are later pending claims. Under the current text, a contributor could see one pending claim and think 1 < 2, even though only one award slot remains. The rule should be closer to:
remaining_slots = max_awards - accepted_or_paid_awards; if pending_claims >= remaining_slots, treat the round as oversubscribed unless a maintainer says overflow will be accepted.
Everything else looks directionally useful, but this line is the core claim-window rule, so it needs to be precise.
Validation run locally:
/Users/jimmy/Documents/Playground/bounty-work/mergework/.venv/bin/python scripts/docs_smoke.py-> docs smoke ok/Users/jimmy/Documents/Playground/bounty-work/mergework/.venv/bin/python -m ruff check docs/agent-guide.md docs/bounty-rules.md-> no Python files under those paths; command exited cleanlygit diff --check origin/main...HEAD-> clean
|
Addressed Zejia's review feedback: the oversubscription check now uses @Zejia please re-review when you have a moment. The fix is in the |
tolga-tom-nook
left a comment
There was a problem hiding this comment.
No blockers from this follow-up docs review.
Evidence checked on head 1124383:
- Inspected
docs/bounty-rules.mdanddocs/agent-guide.mdafter the oversubscription wording update. - Verified the new guidance covers remaining-slot calculation, pending-claim oversubscription risk, evidence expectations for PR submissions/reviews/docs/bug reports, duplicate/vague/self-review rejection cases, and no fiat/price/bridge/cash-out language.
- Ran
./.venv/bin/python scripts/docs_smoke.py->docs smoke ok. - Ran
./.venv/bin/python -m ruff check docs/agent-guide.md docs/bounty-rules.md-> no Python files / no issues. - Ran
git diff --check origin/main...HEAD-> clean.
Note: ruff format --check on Markdown still reports Ruff's Markdown formatter as experimental unless preview mode is enabled, so I did not treat that as a blocker.
aiautotool
left a comment
There was a problem hiding this comment.
The docs content itself looks directionally useful, but this PR is not reviewable as a focused Bounty #383 docs submission yet.\n\nFinding: the PR body describes only claim-window/evidence documentation changes, but the actual diff includes a large stack of unrelated code and test files: app/accounts.py, app/activity.py, app/admin.py, app/hub.py, app/ledger_views.py, app/mcp_work_proof.py, app/main.py, multiple route tests, and submission_quality_gate changes. That mixes several prior code-health/refactor scopes into a docs bounty PR, makes acceptance/award attribution ambiguous, and raises merge risk unrelated to the stated docs change. Please rebase/cherry-pick this onto current main so the PR contains only docs/agent-guide.md and docs/bounty-rules.md changes for #383.\n\nLocal evidence:\n- git diff --stat origin/main...HEAD -> 20 files changed, including app/.py and tests/.py outside the docs bounty scope\n- python scripts/docs_smoke.py -> docs smoke ok\n- git diff --check origin/main...HEAD -> pass
Summary
Evidence
Test Evidence
ruff format --check .ruff check .mypy apppytestpython scripts/docs_smoke.pyMRWK
Related bounty: Bounty #383
Summary by CodeRabbit