docs: close contributor onboarding gaps and correct the v0.4.x release state#135
Merged
Merged
Conversation
Document `pnpm format:check` in both local verification lists and order them to match the CI job. CI enforces the format check but the guide never named it, so a contributor could follow the guide exactly and still fail CI on the first step after lint. Drop the hard-coded counts from the architecture table. The detection entry said 15 rules and has been 16 since REPEATED_BOOT_NOTIFICATION landed. Counts in that table have now drifted twice, so the READMEs stay authoritative and the test suite keeps asserting them. Add both READMEs to the "Adding a Scenario" checklist, note that `ocpp-debugkit ci` covers neither formatting nor lint nor types, and state that each scenario takes its own station ID. Document a one-open-claim-at-a-time policy for good-first-issues. Closes #134
CURRENT_STATE.md is updated inside every PR before merge. Log the first external good-first-issue contribution and the guide fixes it surfaced.
Current Version reported 0.4.1 with a 0.4.2 patch in progress. 0.4.2 is published and holds the latest dist-tag, and both bugs it tracked (#127, #128) are closed. Restate the active milestone as v0.5.0 with v0.4.x complete, add the missing v0.4.x release record to What's Done, and drop the stale request to cut v0.4.0 from What's Next. Closes #136
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #134. Closes #136.
PR #133 was the first external contribution to a
good-first-issue. It failedCI and needed four review items, and three of those four came from gaps in this
guide rather than from anything the contributor did. This closes them.
Changes
pnpm format:checkis now documented. It was enforced by CI and namednowhere in the guide, so following the guide exactly could still fail CI. Both
command lists now match the CI job step for step, with a note that CI stops at
the first failure and that
pnpm formatapplies the fixes.Hard-coded counts are out of the architecture table. The detection entry
claimed 15 rules; there have been 16 since
REPEATED_BOOT_NOTIFICATIONlandedin #114. That table is a map of where code lives, not a specification, and its
counts have drifted twice now. The READMEs remain the place that states them,
and the test suite already fails when those drift.
"Adding a Scenario" names all four files that carry the count, and flags
that only two of them fail the suite when missed, which is what makes the other
two easy to skip. Step 4 now says
ocpp-debugkit cicovers neither formattingnor lint nor types.
Station IDs are documented as unique, with a pointer to check
__scenarios__/for the next free number.Good-first-issues get a claim policy: one open claim at a time. The previous
wording invited contributors to claim as many as they liked, and one claimed
four within three seconds.
Notes
No changeset.
CONTRIBUTING.mdis not in the packagefileslist, so nothinghere ships to npm.
CURRENT_STATE.mdcarries the usual entry, since it is updated inside every PRbefore merge.
Also in here: CURRENT_STATE release state (#136)
Folded in rather than branched separately, because it edits regions of
CURRENT_STATE.mdadjacent to the entry above and two branches would havecollided.
Current Version reported
0.4.1with a0.4.2patch in progress.0.4.2ispublished and holds the
latestdist-tag, thev0.4.2tag and GitHub releaseexist, and both bugs it tracked (#127, #128) are closed. The active milestone now
reads v0.5.0 with v0.4.x complete, What's Done gains the v0.4.x release record it
never had, and What's Next drops the request to cut
v0.4.0, which shipped on2026-07-17.
The scenario count in this table would otherwise have needed a bump when #133
merges. Removing the count instead drops that coupling.
Verification
pnpm format:checkandpnpm lintboth pass. Documentation only, no source ortest files touched.