Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add github issue templates. #1002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/blank_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Blank Issue
description: Submit an issue about Tensorflow.NET.
labels: [Blank Issue]
body:
- type: markdown
id: description
attributes:
label: Description
description: Please describe the issue here.
placeholder: Description
validations:
required: false
- type: markdown
attributes:
value: |
No matched issue template? Try the blank issue! We welcome submitting issues to Tensorflow.NET!
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: BUG Report
description: Report a BUG of Tensorflow.NET.
title: "[BUG Report]: "
labels: [bug-report]
body:
- type: markdown
attributes:
value: |
We welcome bug reports! Any unexpected behavior could be a BUG and this template help us gather the information to fix it.
- type: markdown
id: background
attributes:
label: Description
description: Please share a clear and concise description of the problem.
placeholder: Description
validations:
required: true
- type: markdown
id: repro-steps
attributes:
label: Reproduction Steps
description: |
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.
placeholder: Minimal Reproduction
validations:
required: false
- type: markdown
id: known-workarounds
attributes:
label: Known Workarounds
description: |
Please provide a description of any known workarounds.
placeholder: Known Workarounds
validations:
required: false
- type: markdown
id: configuration
attributes:
label: Configuration and Other Information
description: |
Please provide more information on your configuration:
* Which version of Tensorflow.NET is the code depending on?
* Which version of .NET runtime is the code running on?
* What is the OS?
* Any other information about this problem?
placeholder: Configuration
validations:
required: false
- type: markdown
attributes:
value: |
Thanks for reporting the problem to us!
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/documention_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation Issue
description: Report an issue about Tensorflow.NET ducumention or require a documention.
title: "[Documention Issue]: "
labels: [Documention Issue]
body:
- type: markdown
attributes:
value: |
Welcome to suggest to Tensorflow.NET documention! This template will help us gather the information we need to improve it.
- type: textarea
id: brief-description
attributes:
label: Brief Description
description: Please describe the problem or the requst for new documention here.
placeholder: Description
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
Please provide some alternative information here, if any.
placeholder: Alternatives
validations:
required: false
- type: markdown
attributes:
value: |
Thanks for your contributing!
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Feature Request
description: Request/Propose a new feature of Tensorflow.NET.
title: "[Feature Request]: "
labels: [feature-request]
body:
- type: markdown
attributes:
value: |
We welcome feature proposal/request! This template will help us gather the information we need to implement the new feature.
- type: markdown
id: background
attributes:
label: Background and Feature Description
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.
placeholder: Purpose
validations:
required: true
- type: markdown
id: api-proposal
attributes:
label: API Definition and Usage
description: |
Please tell us the new API related to the requested feature, if any.
placeholder: API declaration (no method bodies)
value: |
```cs
public Tensor NewFunc(Tensor x, int y);

var result = NewFunc(input, index);
```
validations:
required: false
- type: markdown
id: alternatives
attributes:
label: Alternatives
description: |
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.
placeholder: Alternatives
validations:
required: false
- type: markdown
id: risks
attributes:
label: Risks
description: |
Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc.
placeholder: Risks
validations:
required: false
- type: markdown
attributes:
value: |
Thanks for your contributing!
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/performance_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Performance Issue
description: Submit an issue about performance problem or regression of Tensorflow.NET.
title: "[Performance Issue]: "
labels: [Performance Issue]
body:
- type: markdown
attributes:
value: |
We welcome issues about Tensorflow.NET performance! This template will help us gather the information we need to locate the problem improve the performance.
- type: textarea
id: brief-description
attributes:
label: Brief Description
description: Please give a brief description about the performance issue here.
placeholder: Description
validations:
required: true
- type: textarea
id: device-and-context
attributes:
label: Device and Context
description: |
Please describe the device and context you used when you encounter the performance problem/regression.
placeholder: Device and Context
validations:
required: true
- type: textarea
id: benchmark
attributes:
label: Benchmark
description: |
We will appreciate it if you'd like to provide benchmark comparison of the performance issue.
placeholder: Benchmark
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
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.
placeholder: Alternatives
validations:
required: false
- type: markdown
attributes:
value: |
Thanks for your contributing!
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Question
description: Ask any question about Tensorflow.NET and discuss with community members.
title: "[Question]: "
labels: [Question]
body:
- type: markdown
attributes:
value: |
Any question about Tensorflow.NET is welcomed! This template will help us get your point.
- type: textarea
id: description
attributes:
label: Description
description: Please describe your question here.
placeholder: Description
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
Please provide some alternative information here, if any.
placeholder: Alternatives
validations:
required: false
- type: markdown
attributes:
value: |
We are always willing to answer your questions!