Updated GitHub templates
Provides more clarity on the format desired when opening up an issue or a pull request. The order of sections was rearranged to focus on the *why* and *what* of the root issue. Optional sections remain encouraged but are not required.
This commit is contained in:
15
.github/ISSUE_TEMPLATE.md
vendored
15
.github/ISSUE_TEMPLATE.md
vendored
@@ -1,11 +1,14 @@
|
||||
## Overview
|
||||
<!-- Required. Describe, in detail, the behavior experienced and what is desired. -->
|
||||
|
||||
## Steps to Recreate
|
||||
<!-- Optional. List exact steps (numbered list) to reproduce errant behavior. Delete if unused. -->
|
||||
<!-- Required. Describe, briefly, the behavior experienced. -->
|
||||
|
||||
## Screenshots/Screencasts
|
||||
<!-- Optional. Attach screenshot/screencast(s) that demo the behavior. Delete if unused. -->
|
||||
<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
|
||||
|
||||
## Steps to Recreate
|
||||
<!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
|
||||
|
||||
## Desired Behavior
|
||||
<!-- Required. Describe the behavior you'd like to see or your idea of a proposed solution. -->
|
||||
|
||||
## Environment
|
||||
<!-- Optional. What is your operating system, software version(s), etc. Delete if unused. -->
|
||||
<!-- Required. What is your operating system, software version(s), etc. -->
|
||||
|
||||
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,11 +1,11 @@
|
||||
## Overview
|
||||
<!-- Required. Why is this important/necessary? -->
|
||||
|
||||
## Details
|
||||
<!-- Optional. List the key features/highlights as bullet points. Delete if unused. -->
|
||||
|
||||
## Notes
|
||||
<!-- Optional. List additional notes/references as bullet points. Delete if unused. -->
|
||||
<!-- Required. Why is this important/necessary and what is the overarching architecture. -->
|
||||
|
||||
## Screenshots/Screencasts
|
||||
<!-- Optional. Provide supporting image/video. Delete if unused. -->
|
||||
<!-- Optional. Provide supporting image/video. -->
|
||||
|
||||
## Details
|
||||
<!-- Optional. List the key features/highlights as bullet points. -->
|
||||
|
||||
## Notes
|
||||
<!-- Optional. List additional notes/references as bullet points. -->
|
||||
|
||||
Reference in New Issue
Block a user