Repository navigation
docs: add pull request template - #23
Merged
Merged
Conversation
Adds a PR template mirroring the checklist already described in CONTRIBUTING.md (npm test, tests in lib/*.test.mjs, Conventional Commits, one logical change per PR). Includes a release-impact prompt because shipkit publishes releases, so reviewers need changes to preflight, changelog, tagging, or publish behaviour called out explicitly.
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.
Summary
shipkithad no pull request template, so PRs opened with an emptydescription. This adds one that mirrors the checklist already written in
CONTRIBUTING.mdrather than inventing new rules:npm testbefore opening a PRlib/*.test.mjsfor behaviour changesIt also adds a Release impact prompt.
shipkitpublishes releases, so areviewer needs changes to preflight checks, changelog generation, git tagging,
or npm publish behaviour stated explicitly instead of inferred from the diff.
Type of change
Verification
npm test— 8/8 passingChecklist
npm testpasses locallylib/*.test.mjsfor behavior changes