docs: add pull request template - #209
Merged
Merged
Conversation
Adds a PR template based on the rules already in CONTRIBUTING.md (npm test, tests in lib/*.test.mjs, descriptive commits, one logical change per PR, human-only co-author trailers). Includes a badge-output prompt asking for before and after Markdown, since badgekit emits Markdown for READMEs and the rendered result is hard to judge from a diff of the generator alone.
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
badgekithad no pull request template, so PRs opened with an emptydescription. This adds one based on the rules already in
CONTRIBUTING.md:npm testbefore opening a PRlib/*.test.mjsfor behaviour changesIt also adds a Badge output prompt asking for before and after Markdown on
changes to badge generation.
badgekitproduces Markdown that users paste intoa README, so the rendered result is the thing worth reviewing, and it is hard to
judge from a diff of the generator alone.
Type of change
Verification
npm test— all tests passingChecklist
npm testpasses locallylib/*.test.mjsfor behavior changesBadge output
None. Badge generation is unchanged.