Skip to content

Commit bc933cf

Browse files
committed
Update PR template, add issue templates
1 parent e33153b commit bc933cf

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
For this bug report, be sure to include:
2+
* A short, descriptive title. Ideally, other community members should be able to get a good idea of the issue just from reading the title.
3+
* A detailed description of the problem you're experiencing. This should include:
4+
* Expected behavior of the workshop and the actual behavior exhibited.
5+
* Any details of your application environment that may be relevant.
6+
* Commands and output used to reproduce the issue.
7+
* [Markdown][https://guides.github.com/features/mastering-markdown/] formatting as appropriate to make the report easier to read; for example use code blocks when pasting a code snippet and exception stacktraces.
8+
9+
*Description:*
10+
11+
12+
*Expected vs. Actual Behavior:*
13+
14+
15+
*Environment Details:*

.github/ISSUE_TEMPLATE/ENHANCEMENT.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
For this enhancement, be sure to include:
2+
* A short, descriptive title. Ideally, other community members should be able to get a good idea of the enhancement just from reading the title.
3+
* A detailed description of the the proposed enhancement. Include justification for why it should be added to the workshop, and possibly example code to illustrate how it should work.
4+
* link:https://guides.github.com/features/mastering-markdown/[Markdown] formatting as appropriate to make the request easier to read.
5+
* If you intend to implement this enhancement, indicate that you'd like to the issue to be assigned to you.
6+
7+
8+
*Description:*
9+
10+
11+
*Justification (Why should this be added?):*
12+
13+
14+
*Assigned to you? (Y/N)*

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*Issue #, if available:*
1+
*Issue #, if available (include [keywords](https://help.github.com/articles/closing-issues-using-keywords/) to close issue as applicable, e.g. "fixes <##>"):*
22

33
*Description of changes:*
44

0 commit comments

Comments
 (0)