feat: add bug report and PR templates #661
Merged
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
oddgrd
changed the title
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.
This adds a bug report template that users can choose when opening an issue, that requires the user to include some information that is usually needed. To see how it looks rendered, click view file. Or see this link: https://github.com/shuttle-hq/shuttle/blob/f0a5066244b414cec93dabbacf2a4ab0c389dead/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
The user will be able to choose the bug report template or a blank issue (when we add more templates we can disable blank templates), or they can choose to follow a link to our discord.
It also adds a PR template to encourage contributors to self-review and add docs/tests.
Closes #602