Add a pull request template#2155
Open
ChrisJr404 wants to merge 1 commit into
Open
Conversation
Closes dandavison#2153. Mirrors the light-touch shape of the existing bug.md / feature.md issue templates. Just a description block and a testing block, with HTML comments hinting at the kind of git-output examples that have been most useful to reviewers in practice.
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.
Closes #2153.
I kept this in line with the existing
.github/ISSUE_TEMPLATE/bug.mdandfeature.mdshape, which are short and don't load up new contributors with checklists. Two prose blocks (description, testing) and a few HTML hints at the top about the kind of git-output snippets that tend to make review faster.I noticed delta already encourages raw
git --no-pageroutput in the bug template, so I echoed that wording in the comment hints rather than introducing a different one.Happy to drop the comment hints, expand into headings, or add a checklist if you'd rather have something more structured. Easy to iterate on.