Require evidence for every acceptance criterion before a PR is marked ready

Open
  • Is something wrong?
#136 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
markdown, typescript
Domain
devtools

Research direction

The guard rail goes in docs/agents/workflow.md, in the step before a PR is marked ready. The flow-reminders hook that injects that doc is the second touch point, and any test covering it should be checked. Decide whether the reviewer rule goes in a new coding-standards file or in workflow.md, since /code-review must read it. Done when the doc, the hook reminder, the reviewer rule and the PR body deviation section all exist and the PR states the chosen location.

Written by the indexing model from the issue text.

Description

ready-for-agent

What to build

A PR is never marked ready, and no acceptance box is ticked, until each acceptance criterion of every ticket the PR closes maps to named evidence (a test, a run output or a diff line), or is listed as a deviation in the PR body.

Origin: the retro of PR #134. The PR was marked ready with three unmet criteria (a missing expect.json, ten probes never run through the package, a project-specific leak in the package). The maintainer found them by asking, and a second round fixed them.

The flow skills come from Matt Pocock's package and are overwritten by npm run skills:*, so do not edit them. Put the guard rail in docs/agents/workflow.md (the flow-reminders hook already injects it) and add a reviewer rule. This repo has no coding-standards file today: decide whether the reviewer rule goes in a new one or in workflow.md, and say which in the PR.

Completion bar: every criterion mapped to evidence, or listed as a deviation.

Acceptance criteria

  • The workflow doc states the guard rail, in the step that precedes marking a PR ready.
  • The flow-reminders hook surfaces it when a PR step starts, and its test (if any) covers it.
  • A reviewer rule exists, in a place /code-review reads, that flags a criterion with no evidence.
  • The PR body template (or the guard rail) shows where deviations are listed.

Blocked by

None (can start immediately).

Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
2h 8m
Merged PRs (30d)
64

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nemchik/biome-plugin-suitescript

All issues in nemchik/biome-plugin-suitescript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.