Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
Buf/Performance Issue
Installation Issue
Documentation Issue
Feature Request
  • Loading branch information
iLeW committed Jul 16, 2019
1 parent e876779 commit 3affe54
Show file tree
Hide file tree
Showing 5 changed files with 141 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-performance-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug/Performance Issue
about: Use this template for reporting a bug or a performance issue.
title: "[BUG/PERFORMANCE] - Short meaningful description of bug/performance issue"
labels: ''
assignees: ''

---

<em>Please make sure that this is a bug. As per our [GitHub Policy](https://github.com/zurutech/ashpy/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. </em>

**System information**
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- AshPy version:
- TensorFlow version (use command below):
- Python version:
- CUDA/cuDNN version:
- GPU model and memory:

You can collect TensorFlow informations from their environment capture [script](https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh). You can also obtain the TensorFlow version with: `python -c "import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`

**Describe the bug**
A clear and concise description of what the bug is.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Code to reproduce the issue**
Provide a reproducible test case that is the bare minimum necessary to generate the problem.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Other info / logs**
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Documentation Issue
about: Use this template for documentation related
title: "[DOC] - Short meaningful description of documentation issue"
labels: ''
assignees: ''

---

<em>Please make sure that this is a bug. As per our [GitHub Policy](https://github.com/zurutech/ashpy/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub.</em>

## URL(s) with the issue:
Please provide a link to the documentation entry.

## Description of issue (what needs changing):

### Clear description
For example, why should someone use this method? How is it useful?

### Correct links
Is the link to the source code correct?

### Parameters defined
Are all parameters defined and formatted correctly?

### Returns defined
Are return values defined?

### Raises listed and defined
Are the errors defined?

### Usage example
Is there a usage example?

### Request visuals, if applicable
Are there currently visuals? If not, will it clarify the content?
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature Request
about: Use this template for raising a feature request
title: "[FEATURE] - Short meaningful description of feature request"
labels: ''
assignees: ''

---

<em>Please make sure that this is a bug. As per our [GitHub Policy](https://github.com/zurutech/ashpy/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub.</em>

**System information**
- AshPy version (you are using):
- Are you willing to contribute it (Yes/No):

**Describe the feature and the current behavior/state**

**Will this change the current api? How?**

**Who will benefit with this feature?**

**Any Other info**
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Use this template for raising a feature request
title: "[FEATURE] - Short meaningful description of feature request"
labels: ''
assignees: ''

---

<em>Please make sure that this is a bug. As per our [GitHub Policy](https://github.com/zurutech/ashpy/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub.</em>

**System information**
- AshPy version (you are using):
- Are you willing to contribute it (Yes/No):

**Describe the feature and the current behavior/state**

**Will this change the current api? How?**

**Who will benefit with this feature?**

**Any Other info**
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/installation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Installation Issue
about: Use this template for installation issues.
title: "[INSTALLATION] - Short meaningful description of installation issue"
labels: ''
assignees: ''

---

<em>Please make sure that this is a bug. As per our [GitHub Policy](https://github.com/zurutech/ashpy/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. </em>

**System information**
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- AshPy version:
- TensorFlow version:
- Python version:
- Installed using virtualenv? pip?:
- CUDA/cuDNN version:
- GPU model and memory:

**Describe the problem**

**Provide the exact sequence of commands / steps that you executed before running into the problem**

**Any other info / logs**
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached.

0 comments on commit 3affe54

Please sign in to comment.