docs: bring CONTRIBUTING and the templates in line with the repository - #78
Merged
Merged
Conversation
CONTRIBUTING.md named a branch that no longer exists (feat/v3-foundation) and said 2.x is still npm's latest, which it has not been since 3.0.0; 2.x fixes now go out under the maintenance-2x dist-tag. Its command list left format:check out of quality and the two fixtures out of typecheck. The documentation site shows the same page. The bug report template gave 0.2.0 and Node 20.0.0 as examples, the latter below the supported minimum; it now says where to read each value. The pull request template listed test, lint and typecheck separately; it now names the gate CI runs, npm run quality, and verify:package for changes that can affect the packed package. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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.
Brings
CONTRIBUTING.mdand the issue and pull request templates in line with the repository. No code changes.What changed
CONTRIBUTING.md(also shown on the documentation site)main; thefeat/v3-foundationbranch it named no longer exists.latest— that has been the v3 line since 3.0.0. 2.x fixes are published under themaintenance-2xdist-tag (ci: keep a 2.x release from moving the latest tag #77).qualityalso runsformat:check, andtypecheckalso checks both fixtures, aspackage.jsondoes.0.2.0and Node20.0.0, the latter below the supported minimum. It now says where to read each value instead of naming one.test,lintandtypecheckseparately. It now names the gate CI runs,npm run quality, andverify:packagefor changes that can affect the packed package.Verification
package.json(quality=format:check+typecheck+lint+test:coverage+knip+docs:api).🤖 Generated with Claude Code