Introduce PR and Issue templates, move contributing doc #247
Conversation
This file contains 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
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to change) |
There was a problem hiding this comment.
Task lists add up in the PR summary screen as a progress bar. Maybe use a regular bulleted list here to not overload it with IMO meaningless "TODOs"?
I think using GitHub task lists for the checklist section below makes sense since they're post-merge steps.
There was a problem hiding this comment.
Made changes to make this more useful. Also updated the description here to reflect the example usage.
|
👻 |
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.
Description
This change adds automatic templates for pull requests and issues. This PR description was created using the template (gotta dogfood it after all). The templates, along with the
CONTRIBUTING.mdfile, are placed in the.githubdirectory to reduce clutter in the project root.These templates were generated with Issue and Pull Request Template Generator - Github repo.
Motivation and Context
Issues and pull requests should be consistent when possible. This should make it easier to read through them quickly. Additionally, submitters should have an easier time knowing what to fill out. That said these templates are by no means required - a submitter can always clear everything out and write a description from scratch.
How Has This Been Tested?
N/A - just need feedback from other contributors and users. 😄
Screenshots (if appropriate):
Types of changes
Checklist: