contributor-checklist-clarity: Contributor Checklist Clarity #4

Open
std-bot wants to merge 1 commit from task/contributor-checklist-clarity into main
First-time contributor

Assigned idea

Benchmark authoring specification.

Summary: Add a precise pre-PR validation checklist to CONTRIBUTING.md so contributors can quickly confirm the documented Node, pnpm, typecheck, build, and docs-update expectations.

Task intent: Improve CONTRIBUTING.md by making the existing contributor validation expectations explicit and easy to follow before sharing changes upstream.

Benchmark plan: Construct a docs-only work item against the pinned repo commit. The solver prompt should ask for a focused CONTRIBUTING.md update that adds a new pre-PR validation checklist using the existing documented prerequisites and checks: Node.js >= 20, pnpm >= 9, pnpm typecheck, pnpm build, and docs updates when behavior or contracts change. Keep the requested change narrow and avoid asking for package, build, or application code edits.

Environment plan: Repository environment: provide the Hunch It checkout at the fixed commit; Node.js >= 20 and pnpm >= 9 are documented for normal project development, but this work item should not require Docker, database setup, or app startup. Verification environment: use Python 3 standard library only to inspect CONTRIBUTING.md, so verifier execution is independent of pnpm install.

Verifier plan: Implement test_outputs.py to read CONTRIBUTING.md and assert that a new checklist-style subsection exists, includes Node.js >= 20 and pnpm >= 9, names pnpm typecheck before pnpm build, mentions updating docs for setup/product/API/user-facing flow changes, and does not modify unrelated files. The verifier should fail if the commands are missing, reordered, or placed only in prose without a checklist.

Oracle plan: The oracle solution is a minimal patch to CONTRIBUTING.md adding a clearly titled pre-PR validation checklist near the existing Development Basics section while preserving the existing contribution flow and command block.

Difficulty plan: Automated coding systems may overreach by editing package scripts, adding new tooling, or rewriting the whole contributing guide instead of making the narrow documentation clarification. They may also miss the required command ordering or omit the version prerequisites.

Repo patch scope: Expected upstream edit scope is CONTRIBUTING.md only.

Anti-leakage notes: Do not expose solver-facing references to benchmark, harness, Snorkel, Harbor, std-ts, agent, stage, attempt, retry, generated task, or evaluation context. Present only the upstream documentation improvement request.

Approach: Author a focused prompt that asks for a contributor-facing checklist, then compare the submitted repository against the expected CONTRIBUTING.md-only change.

Verification: Run python test_outputs.py; it must inspect CONTRIBUTING.md and verify the required heading, checklist content, command ordering, and file-scope constraints.

Risk: Low risk: the change is documentation-only, but the verifier must avoid being so brittle that harmless wording differences fail while still enforcing the required concrete content.

Path rules: task package is tasks/; mutable upstream checkout is tasks//environment/repo; benchmark package files are under tasks//task; verifier/container environment belongs under tasks//task/environment; regular and UI verifier logic belongs in task/tests/test_outputs.py and test.sh only runs that file through pytest.

Agent context

Task slug: contributor-checklist-clarity
Branch: task/contributor-checklist-clarity

## Assigned idea Benchmark authoring specification. Summary: Add a precise pre-PR validation checklist to CONTRIBUTING.md so contributors can quickly confirm the documented Node, pnpm, typecheck, build, and docs-update expectations. Task intent: Improve CONTRIBUTING.md by making the existing contributor validation expectations explicit and easy to follow before sharing changes upstream. Benchmark plan: Construct a docs-only work item against the pinned repo commit. The solver prompt should ask for a focused CONTRIBUTING.md update that adds a new pre-PR validation checklist using the existing documented prerequisites and checks: Node.js >= 20, pnpm >= 9, `pnpm typecheck`, `pnpm build`, and docs updates when behavior or contracts change. Keep the requested change narrow and avoid asking for package, build, or application code edits. Environment plan: Repository environment: provide the Hunch It checkout at the fixed commit; Node.js >= 20 and pnpm >= 9 are documented for normal project development, but this work item should not require Docker, database setup, or app startup. Verification environment: use Python 3 standard library only to inspect CONTRIBUTING.md, so verifier execution is independent of pnpm install. Verifier plan: Implement test_outputs.py to read CONTRIBUTING.md and assert that a new checklist-style subsection exists, includes Node.js >= 20 and pnpm >= 9, names `pnpm typecheck` before `pnpm build`, mentions updating docs for setup/product/API/user-facing flow changes, and does not modify unrelated files. The verifier should fail if the commands are missing, reordered, or placed only in prose without a checklist. Oracle plan: The oracle solution is a minimal patch to CONTRIBUTING.md adding a clearly titled pre-PR validation checklist near the existing Development Basics section while preserving the existing contribution flow and command block. Difficulty plan: Automated coding systems may overreach by editing package scripts, adding new tooling, or rewriting the whole contributing guide instead of making the narrow documentation clarification. They may also miss the required command ordering or omit the version prerequisites. Repo patch scope: Expected upstream edit scope is CONTRIBUTING.md only. Anti-leakage notes: Do not expose solver-facing references to benchmark, harness, Snorkel, Harbor, std-ts, agent, stage, attempt, retry, generated task, or evaluation context. Present only the upstream documentation improvement request. Approach: Author a focused prompt that asks for a contributor-facing checklist, then compare the submitted repository against the expected CONTRIBUTING.md-only change. Verification: Run `python test_outputs.py`; it must inspect `CONTRIBUTING.md` and verify the required heading, checklist content, command ordering, and file-scope constraints. Risk: Low risk: the change is documentation-only, but the verifier must avoid being so brittle that harmless wording differences fail while still enforcing the required concrete content. Path rules: task package is tasks/<slug>; mutable upstream checkout is tasks/<slug>/environment/repo; benchmark package files are under tasks/<slug>/task; verifier/container environment belongs under tasks/<slug>/task/environment; regular and UI verifier logic belongs in task/tests/test_outputs.py and test.sh only runs that file through pytest. ## Agent context Task slug: contributor-checklist-clarity Branch: task/contributor-checklist-clarity <!-- std-ts:idea-pr-body -->
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin task/contributor-checklist-clarity:task/contributor-checklist-clarity
git switch task/contributor-checklist-clarity

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main
git merge --no-ff task/contributor-checklist-clarity
git switch task/contributor-checklist-clarity
git rebase main
git switch main
git merge --ff-only task/contributor-checklist-clarity
git switch task/contributor-checklist-clarity
git rebase main
git switch main
git merge --no-ff task/contributor-checklist-clarity
git switch main
git merge --squash task/contributor-checklist-clarity
git switch main
git merge --ff-only task/contributor-checklist-clarity
git switch main
git merge task/contributor-checklist-clarity
git push origin main
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
snorkel/root-repository-maintenance-211720333dcd47!4
No description provided.