Skip to content

Commit

Permalink
[Docs] Update ISSUE_TEMPLATE docs for github. (DeepRec-AI#793)
Browse files Browse the repository at this point in the history
  • Loading branch information
liutongxuan authored Apr 3, 2023
1 parent fd8f7f6 commit c31da68
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 112 deletions.
18 changes: 4 additions & 14 deletions .github/ISSUE_TEMPLATE/00-bug-performance-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,22 @@ about: Use this template for reporting a bug or a performance issue.

---

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

**System information**
- Have I written custom code (as opposed to using a stock example script provided in TensorFlow):
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- Mobile device (e.g. iPhone 8, Pixel 2, Samsung Galaxy) if the issue happens on mobile device:
- TensorFlow installed from (source or binary):
- TensorFlow version (use command below):
- OS Platform and Distribution (e.g., Linux Ubuntu 20.04):
- DeepRec version or commit id:
- Python version:
- Bazel version (if compiling from source):
- GCC/Compiler version (if compiling from source):
- CUDA/cuDNN version:
- GPU model and memory:

You can collect some of this information using our environment capture
[script](https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh)
You can also obtain the TensorFlow version with: 1. TF 1.0: `python -c "import
tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"` 2. TF 2.0: `python -c
"import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"`

**Describe the current behavior**

**Describe the expected behavior**

**Code to reproduce the issue**

Provide a reproducible test case that is the bare minimum necessary to generate the 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.
16 changes: 4 additions & 12 deletions .github/ISSUE_TEMPLATE/10-build-installation-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,18 @@ about: Use this template for build/installation issues

---

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

**System information**
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
- Mobile device (e.g. iPhone 8, Pixel 2, Samsung Galaxy) if the issue happens on mobile device:
- TensorFlow installed from (source or binary):
- TensorFlow version:
- OS Platform and Distribution (e.g., Linux Ubuntu 20.04):
- DeepRec version or commit id:
- Python version:
- Installed using virtualenv? pip? conda?:
- Bazel version (if compiling from source):
- GCC/Compiler version (if compiling from source):
- 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.

Include any logs or source code that would be helpful to diagnose the problem.
48 changes: 3 additions & 45 deletions .github/ISSUE_TEMPLATE/20-documentation-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,9 @@ labels: 'type:docs'

---

Thank you for submitting a TensorFlow documentation issue. Per our GitHub
policy, we only address code/doc bugs, performance issues, feature requests, and
build/installation issues on GitHub.
The DeepRec docs are open source! To get involved, read the user documents: https://deeprec.readthedocs.io/en/latest/index.html

The TensorFlow docs are open source! To get involved, read the documentation
contributor guide: https://www.tensorflow.org/community/contribute/docs
**URL(s) with the issue**

## URL(s) with the issue:
**Description of issue (what needs changing)**

Please provide a link to the documentation entry, for example:
https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/MyMethod

## 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? For example,
https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/feature_column/categorical_column_with_vocabulary_file#raises

### Usage example

Is there a usage example?

### Request visuals, if applicable

Are there currently visuals? If not, will it clarify the content?

### Submit a pull request?

Are you planning to also submit a pull request to fix the issue? See the docs
contributor guide: https://www.tensorflow.org/community/contribute/docs and the
docs style guide: https://www.tensorflow.org/community/contribute/docs_style
5 changes: 1 addition & 4 deletions .github/ISSUE_TEMPLATE/30-feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,12 @@ about: Use this template for raising a feature request

---

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


**System information**
- TensorFlow version (you are using):
- DeepRec 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?**
Expand Down
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/40-other-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Other Issues
about: Use this template for any other non-support related issues

---

This template is for miscellaneous issues not covered by the other issue categories.

24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/40-tflite-op-request.md

This file was deleted.

13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE/50-other-issues.md

This file was deleted.

0 comments on commit c31da68

Please sign in to comment.