Skip to content

Commit 7d7858c

Browse files
AsakusaRinneOceania2018
AsakusaRinne
authored and
Oceania2018
committed
Add github issue templates.
1 parent f0e129e commit 7d7858c

File tree

6 files changed

+230
-0
lines changed

6 files changed

+230
-0
lines changed

‎.github/ISSUE_TEMPLATE/blank_issue.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Blank Issue
2+
description: Submit an issue about Tensorflow.NET.
3+
labels: [Blank Issue]
4+
body:
5+
- type: markdown
6+
id: description
7+
attributes:
8+
label: Description
9+
description: Please describe the issue here.
10+
placeholder: Description
11+
validations:
12+
required: false
13+
- type: markdown
14+
attributes:
15+
value: |
16+
No matched issue template? Try the blank issue! We welcome submitting issues to Tensorflow.NET!

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: BUG Report
2+
description: Report a BUG of Tensorflow.NET.
3+
title: "[BUG Report]: "
4+
labels: [bug-report]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We welcome bug reports! Any unexpected behavior could be a BUG and this template help us gather the information to fix it.
10+
- type: markdown
11+
id: background
12+
attributes:
13+
label: Description
14+
description: Please share a clear and concise description of the problem.
15+
placeholder: Description
16+
validations:
17+
required: true
18+
- type: markdown
19+
id: repro-steps
20+
attributes:
21+
label: Reproduction Steps
22+
description: |
23+
Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small project, with steps to run it. It will greatly help us to locate the reason of the problem.
24+
placeholder: Minimal Reproduction
25+
validations:
26+
required: false
27+
- type: markdown
28+
id: known-workarounds
29+
attributes:
30+
label: Known Workarounds
31+
description: |
32+
Please provide a description of any known workarounds.
33+
placeholder: Known Workarounds
34+
validations:
35+
required: false
36+
- type: markdown
37+
id: configuration
38+
attributes:
39+
label: Configuration and Other Information
40+
description: |
41+
Please provide more information on your configuration:
42+
* Which version of Tensorflow.NET is the code depending on?
43+
* Which version of .NET runtime is the code running on?
44+
* What is the OS?
45+
* Any other information about this problem?
46+
placeholder: Configuration
47+
validations:
48+
required: false
49+
- type: markdown
50+
attributes:
51+
value: |
52+
Thanks for reporting the problem to us!

‎.github/ISSUE_TEMPLATE/documention_issue.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Documentation Issue
2+
description: Report an issue about Tensorflow.NET ducumention or require a documention.
3+
title: "[Documention Issue]: "
4+
labels: [Documention Issue]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Welcome to suggest to Tensorflow.NET documention! This template will help us gather the information we need to improve it.
10+
- type: textarea
11+
id: brief-description
12+
attributes:
13+
label: Brief Description
14+
description: Please describe the problem or the requst for new documention here.
15+
placeholder: Description
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: alternatives
20+
attributes:
21+
label: Alternatives
22+
description: |
23+
Please provide some alternative information here, if any.
24+
placeholder: Alternatives
25+
validations:
26+
required: false
27+
- type: markdown
28+
attributes:
29+
value: |
30+
Thanks for your contributing!

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Feature Request
2+
description: Request/Propose a new feature of Tensorflow.NET.
3+
title: "[Feature Request]: "
4+
labels: [feature-request]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We welcome feature proposal/request! This template will help us gather the information we need to implement the new feature.
10+
- type: markdown
11+
id: background
12+
attributes:
13+
label: Background and Feature Description
14+
description: Please describe the purpose and value of the new feature here. If the feature is linked to a specific problem, please describe it or put the link here.
15+
placeholder: Purpose
16+
validations:
17+
required: true
18+
- type: markdown
19+
id: api-proposal
20+
attributes:
21+
label: API Definition and Usage
22+
description: |
23+
Please tell us the new API related to the requested feature, if any.
24+
placeholder: API declaration (no method bodies)
25+
value: |
26+
```cs
27+
public Tensor NewFunc(Tensor x, int y);
28+
29+
var result = NewFunc(input, index);
30+
```
31+
validations:
32+
required: false
33+
- type: markdown
34+
id: alternatives
35+
attributes:
36+
label: Alternatives
37+
description: |
38+
Please provide some alternative information of the feature, if any. For example, if you request a feature which depends on a specific device, please provide the device information.
39+
placeholder: Alternatives
40+
validations:
41+
required: false
42+
- type: markdown
43+
id: risks
44+
attributes:
45+
label: Risks
46+
description: |
47+
Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc.
48+
placeholder: Risks
49+
validations:
50+
required: false
51+
- type: markdown
52+
attributes:
53+
value: |
54+
Thanks for your contributing!

‎.github/ISSUE_TEMPLATE/performance_issue.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Performance Issue
2+
description: Submit an issue about performance problem or regression of Tensorflow.NET.
3+
title: "[Performance Issue]: "
4+
labels: [Performance Issue]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We welcome issues about Tensorflow.NET performance! This template will help us gather the information we need to locate the problem improve the performance.
10+
- type: textarea
11+
id: brief-description
12+
attributes:
13+
label: Brief Description
14+
description: Please give a brief description about the performance issue here.
15+
placeholder: Description
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: device-and-context
20+
attributes:
21+
label: Device and Context
22+
description: |
23+
Please describe the device and context you used when you encounter the performance problem/regression.
24+
placeholder: Device and Context
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: benchmark
29+
attributes:
30+
label: Benchmark
31+
description: |
32+
We will appreciate it if you'd like to provide benchmark comparison of the performance issue.
33+
placeholder: Benchmark
34+
validations:
35+
required: false
36+
- type: textarea
37+
id: alternatives
38+
attributes:
39+
label: Alternatives
40+
description: |
41+
Please provide some alternative information of the performance issue here, if any. For example, we'll appreciate it if you'd like to provide the the code to reproduce the performance problem.
42+
placeholder: Alternatives
43+
validations:
44+
required: false
45+
- type: markdown
46+
attributes:
47+
value: |
48+
Thanks for your contributing!

‎.github/ISSUE_TEMPLATE/question.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Question
2+
description: Ask any question about Tensorflow.NET and discuss with community members.
3+
title: "[Question]: "
4+
labels: [Question]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Any question about Tensorflow.NET is welcomed! This template will help us get your point.
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: Please describe your question here.
15+
placeholder: Description
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: alternatives
20+
attributes:
21+
label: Alternatives
22+
description: |
23+
Please provide some alternative information here, if any.
24+
placeholder: Alternatives
25+
validations:
26+
required: false
27+
- type: markdown
28+
attributes:
29+
value: |
30+
We are always willing to answer your questions!

0 commit comments

Comments
 (0)