diff --git a/.github/ISSUE_TEMPLATE/bug-performance-issue.md b/.github/ISSUE_TEMPLATE/bug-performance-issue.md new file mode 100644 index 00000000000..c590a962cb7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-performance-issue.md @@ -0,0 +1,35 @@ +-------------------------------------------------------------------------------- + +name: Bug/Performance Issue 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): - 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 python -c "import tensorflow as +tf; print(tf.GIT_VERSION, tf.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/build-installation-issue.md b/.github/ISSUE_TEMPLATE/build-installation-issue.md new file mode 100644 index 00000000000..fac9ddfbd70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/build-installation-issue.md @@ -0,0 +1,27 @@ +-------------------------------------------------------------------------------- + +name: Build/Installation Issue 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: - 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. diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.md b/.github/ISSUE_TEMPLATE/documentation-issue.md new file mode 100644 index 00000000000..610da5dd467 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-issue.md @@ -0,0 +1,18 @@ +-------------------------------------------------------------------------------- + +name: Documentation Issue about: Use this template for documentation related +issues + +-------------------------------------------------------------------------------- + +Please make sure that this is a documentation 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:doc_template + +**System information** - TensorFlow version: - Doc Link: + +**Describe the documentation issue** + +**We welcome contributions by users. Will you be able to update submit a PR to +fix the doc Issue?** diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000000..9f06e1759ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,21 @@ +-------------------------------------------------------------------------------- + +name: Feature Request 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): - 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.** diff --git a/.github/ISSUE_TEMPLATE/other-issues.md b/.github/ISSUE_TEMPLATE/other-issues.md new file mode 100644 index 00000000000..b53bdb3c168 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issues.md @@ -0,0 +1,21 @@ +-------------------------------------------------------------------------------- + +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. diff --git a/ISSUES.md b/ISSUES.md new file mode 100644 index 00000000000..2b330e8e0a8 --- /dev/null +++ b/ISSUES.md @@ -0,0 +1,9 @@ +If you open a GitHub Issue, here is our policy: 1. It must be a bug/performance +issue or a feature request or a build issue or a documentation issue (for small +doc fixes please send a PR instead). 2. Make sure the Issue Template is filled +out. 3. The issue should be related to the repo it is created in. + +**Here's why we have this policy:** We want to focus on the work that benefits +the whole community, e.g., fixing bugs and adding features. Individual support +should be seeked on StackOverflow or other non-GitHub channels. It helps us to +address bugs and feature requests in a timely manner.