forked from oneapi-src/oneDNN
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Separate templates for bugs, features and questions
- Loading branch information
Showing
5 changed files
with
92 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: Report a bug or a performance issue | ||
about: Use this template to report unexpected behavior | ||
title: '' | ||
labels: 'sighting' | ||
assignees: '' | ||
--- | ||
|
||
# Summary | ||
Provide a short summary of the issue. Sections below provide guidance on what | ||
factors are considered important to reproduce an issue. | ||
|
||
# Version | ||
Report DNNL version and githash. Version information is printed to stdout | ||
in [verbose mode](http://intel.github.io/mkl-dnn/dev_guide_verbose.html). | ||
|
||
# Environment | ||
DNNL includes hardware-specific optimizations and may behave | ||
differently on depending on the compiler and build environment. Include | ||
the following information to help reproduce the issue: | ||
* CPU make and model (try `lscpu`; if your `lscpu` does not list CPU flags, | ||
try running `cat /proc/cpuinfo | grep flags | sort -u`) | ||
* OS version (`uname -a`) | ||
* Compiler version (`gcc --version`) | ||
* CMake version (`cmake --version`) | ||
* CMake output log | ||
* git hash (`git log -1 --format=%H`) | ||
|
||
# Steps to reproduce | ||
Please check that the issue is reproducible with the latest revision on | ||
master. Include all the steps to reproduce the issue. | ||
|
||
You can use [verbose mode](http://intel.github.io/mkl-dnn/dev_guide_verbose.html) | ||
and [benchdnn](https://github.com/intel/mkl-dnn/tree/master/tests/benchdnn) | ||
to validate correctness of all primitives the library supports. If this does not | ||
work a short C/C++ program or modified unit tests demonstrating the issue | ||
will greatly help with the investigation. | ||
|
||
# Observed behavior | ||
Document behavior you observe. For performance defects, like performance | ||
regressions or a function being slow, provide a log including output generated | ||
by your application in | ||
[verbose mode](http://intel.github.io/mkl-dnn/dev_guide_verbose.html). | ||
|
||
# Expected behavior | ||
Document behavior you expect. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Request a documentation change | ||
about: Use this template to report documentation issue or request documentation changes | ||
title: '' | ||
labels: 'documentation' | ||
assignees: '' | ||
--- | ||
|
||
# Summary | ||
Include a short summary of the issue or request. Sections below provide | ||
guidance on what factors are considered important for a documentation | ||
issue. | ||
|
||
# URLs | ||
Include pointers to documents that are impacted. | ||
|
||
# Additional details | ||
Provide detailed description of the expected changes in documentation | ||
and suggestions you have. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Request a feature | ||
about: Use this template to request new functionality or change behavior of the library | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
--- | ||
|
||
# Summary | ||
Include a short summary of the request. Sections below provide guidance on | ||
what factors are considered important for a feature request. | ||
|
||
# Problem statement | ||
Describe the problem you are trying to solve with reasonable level of details. | ||
Engineering problems may be hard to pinpoint and may have multiple solutions. | ||
Assumed solution might not be the best solution or a solution at all, | ||
see the [XY problem](http://xyproblem.info/). | ||
|
||
# Preferred solution | ||
Document your thoughts on what solution may look like. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
name: Ask a question | ||
about: Use this template for everything that is not a bug or a feature request | ||
title: '' | ||
labels: 'question' | ||
assignees: '' | ||
--- |
This file was deleted.
Oops, something went wrong.