diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md index 572a52c2d..a36b5eabd 100644 --- a/.github/ISSUE_TEMPLATE/bugs.md +++ b/.github/ISSUE_TEMPLATE/bugs.md @@ -1,26 +1,24 @@ ## Expected Behavior - - +If you're describing a bug, tell us what should happen +If you're suggesting a change/improvement, tell us how it should work ## Current Behavior - - +If describing a bug, tell us what happens instead of the expected behavior +If suggesting a change/improvement, explain the difference from current behavior ## Possible Solution - - +Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change ## Steps to Reproduce (for bugs) - - +Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant 1. 2. 3. 4. ## Context - - +How has this issue affected you? What are you trying to accomplish? +Providing context helps us come up with a solution that is most useful in the real world ## Your Environment - +Include as many relevant details about the environment you experienced the bug in diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index cdecf2a0d..ab91021d3 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -1,12 +1,11 @@ ## Background - - +Explain the purpose of the feature and the context in which it will be used +Link to an issue or PR that describes the feature in more detail, if applicable. ## Requirements - +Describe the requirements that this feature must meet. - [ ] Requirement 1 -## Important Info - -- +## Important Information +Additional important information such as links to resources.