From c31da6827e8f1a4d8ccc913dcfc2b3b04877457b Mon Sep 17 00:00:00 2001 From: Tongxuan Liu Date: Mon, 3 Apr 2023 15:40:17 +0800 Subject: [PATCH] [Docs] Update ISSUE_TEMPLATE docs for github. (#793) --- .../00-bug-performance-issue.md | 18 ++----- .../10-build-installation-issue.md | 16 ++----- .../ISSUE_TEMPLATE/20-documentation-issue.md | 48 ++----------------- .github/ISSUE_TEMPLATE/30-feature-request.md | 5 +- .github/ISSUE_TEMPLATE/40-other-issues.md | 8 ++++ .../ISSUE_TEMPLATE/40-tflite-op-request.md | 24 ---------- .github/ISSUE_TEMPLATE/50-other-issues.md | 13 ----- 7 files changed, 20 insertions(+), 112 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/40-other-issues.md delete mode 100644 .github/ISSUE_TEMPLATE/40-tflite-op-request.md delete mode 100644 .github/ISSUE_TEMPLATE/50-other-issues.md diff --git a/.github/ISSUE_TEMPLATE/00-bug-performance-issue.md b/.github/ISSUE_TEMPLATE/00-bug-performance-issue.md index d562ced6f3a..644a54477ec 100644 --- a/.github/ISSUE_TEMPLATE/00-bug-performance-issue.md +++ b/.github/ISSUE_TEMPLATE/00-bug-performance-issue.md @@ -4,32 +4,22 @@ about: Use this template for reporting a bug or a performance issue. --- -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 - **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. diff --git a/.github/ISSUE_TEMPLATE/10-build-installation-issue.md b/.github/ISSUE_TEMPLATE/10-build-installation-issue.md index 99c2fe61271..a1575eae8cf 100644 --- a/.github/ISSUE_TEMPLATE/10-build-installation-issue.md +++ b/.github/ISSUE_TEMPLATE/10-build-installation-issue.md @@ -4,26 +4,18 @@ about: Use this template for build/installation issues --- -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 - **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. diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.md b/.github/ISSUE_TEMPLATE/20-documentation-issue.md index 7f4a1f1b5b0..7efafdb3ef6 100644 --- a/.github/ISSUE_TEMPLATE/20-documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/20-documentation-issue.md @@ -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 diff --git a/.github/ISSUE_TEMPLATE/30-feature-request.md b/.github/ISSUE_TEMPLATE/30-feature-request.md index 71df2e5e49f..a9a92496c06 100644 --- a/.github/ISSUE_TEMPLATE/30-feature-request.md +++ b/.github/ISSUE_TEMPLATE/30-feature-request.md @@ -4,15 +4,12 @@ about: Use this template for raising a feature request --- -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 - **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?** diff --git a/.github/ISSUE_TEMPLATE/40-other-issues.md b/.github/ISSUE_TEMPLATE/40-other-issues.md new file mode 100644 index 00000000000..8825098fd2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/40-other-issues.md @@ -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. + diff --git a/.github/ISSUE_TEMPLATE/40-tflite-op-request.md b/.github/ISSUE_TEMPLATE/40-tflite-op-request.md deleted file mode 100644 index 7b391279e47..00000000000 --- a/.github/ISSUE_TEMPLATE/40-tflite-op-request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: TensorFlow Lite Op Request -about: Use this template for reporting ops you are using or missing. - ---- - - -**System information** -- OS Platform and Distribution (e.g., Linux Ubuntu 16.04): -- TensorFlow installed from (source or binary): -- TensorFlow version (or github SHA if from source): - - -**Provide the text output from tflite_convert** - -``` -# Copy and paste here -``` - -Also, please include a link to a GraphDef or the model if possible. - -**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. diff --git a/.github/ISSUE_TEMPLATE/50-other-issues.md b/.github/ISSUE_TEMPLATE/50-other-issues.md deleted file mode 100644 index 2d78d9818bb..00000000000 --- a/.github/ISSUE_TEMPLATE/50-other-issues.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -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. - -For questions on how to work with TensorFlow, or support for problems that are not verified bugs in TensorFlow, please go to [StackOverflow](https://stackoverflow.com/questions/tagged/tensorflow). - -If you are reporting a vulnerability, please use the [dedicated reporting process](https://github.com/tensorflow/tensorflow/blob/master/SECURITY.md). - -For high-level discussions about TensorFlow, please post to discuss@tensorflow.org, for questions about the development or internal workings of TensorFlow, or if you would like to know how to contribute to TensorFlow, please post to developers@tensorflow.org.