Skip to content

Commit 3663c0c

Browse files
syurkevipradeepumar456
authored
Create issue templates (#2928)
Adds several classes of issues with proposed additional information that would be helpful when debugging. Co-authored-by: pradeep <pradeep@arrayfire.com> Co-authored-by: Umar Arshad <umar@arrayfire.com>
1 parent 0c53e09 commit 3663c0c

5 files changed

Lines changed: 186 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: Bug Report
3+
about: Create a bug report to help us improve ArrayFire
4+
title: "[BUG]"
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
<!-- One to two sentences discription of the bug -->
10+
11+
Description
12+
===========
13+
<!--
14+
* Additional details regarding the bug
15+
* Did you build ArrayFire yourself or did you use the official installers
16+
* Which backend is experiencing this issue? (CPU, CUDA, OpenCL)
17+
* Do you have a workaround?
18+
* Can the bug be reproduced reliably on your system?
19+
* A clear and concise description of what you expected to happen.
20+
* Run your executable with AF_TRACE=all and AF_PRINT_ERRORS=1 environment
21+
variables set.
22+
* Screenshot or terminal output of the results
23+
-->
24+
25+
Reproducible Code and/or Steps
26+
------------------------------
27+
<!--
28+
* Steps or code snippet that can reproduce the bug
29+
* A full example will allow us to debug and fix the bug faster
30+
-->
31+
32+
System Information
33+
------------------
34+
<!--
35+
Please provide the following information:
36+
1. ArrayFire version
37+
2. Devices installed on the system
38+
3. (optional) Output from the af::info() function if applicable.
39+
4. Output from the following scripts:
40+
41+
Run one of the following commands based on your OS
42+
43+
Linux:
44+
```sh
45+
lsb_release -a
46+
if command -v nvidia-smi >/dev/null; then
47+
nvidia-smi --query-gpu="name,memory.total,driver_version" --format=csv -i 0
48+
else
49+
echo "nvidia-smi not found"
50+
fi
51+
if command -v /opt/rocm/bin/rocm-smi >/dev/null; then
52+
/opt/rocm/bin/rocm-smi --showproductname
53+
else
54+
echo "rocm-smi not found."
55+
fi
56+
if command -v clinfo > /dev/null; then
57+
clinfo
58+
else
59+
echo "clinfo not found."
60+
fi
61+
```
62+
63+
Windows:
64+
Download clinfo from https://github.com/Oblomov/clinfo
65+
66+
If you have NVIDIA GPUs. Run nvidia-smi usually located in
67+
C:\Program Files\NVIDIA Corporation\NVSMI
68+
69+
Provide driver version for your GPU. (This is vendor specific)
70+
-->
71+
72+
Checklist
73+
---------
74+
75+
- [ ] Using the latest available ArrayFire release
76+
- [ ] GPU drivers are up to date

‎.github/ISSUE_TEMPLATE/build_error.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Build Error
3+
about: Create a report for errors during the building process
4+
title: "[Build]"
5+
labels: 'build'
6+
assignees: ''
7+
---
8+
9+
<!--
10+
A short one or two line description of the error
11+
-->
12+
13+
Description
14+
===========
15+
16+
<!--
17+
* Additional details about the errors during the build
18+
* What do you suspect is causing the issue?
19+
* Which steps in the (wiki)[https://github.com/arrayfire/arrayfire/wiki] failed
20+
* What operating system and/or distro are you using?
21+
* Versions of the packages related to this bug
22+
-->
23+
24+
Error Log
25+
---------
26+
<!-- Output of the error log. -->
27+
```
28+
29+
```
30+
31+
Build Environment
32+
-----------------
33+
Compiler version: <!-- MSVC v140 or gcc 9.3.2 -->
34+
Operating system: <!-- Windows 10; Ubuntu 18.04 -->
35+
Build environment: <!-- Environment variables; Installed software -->
36+
CMake variables: <!-- Output of `cmake -L` -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new idea for ArrayFire
4+
title: ''
5+
labels: 'feature'
6+
assignees: ''
7+
8+
---
9+
10+
<!-- One or two sentences describing the feature. -->
11+
12+
Description
13+
===========
14+
<!--
15+
* Additional information about the feature you would like to add
16+
* What problem are you trying to solve?
17+
* (Optional) API of new function
18+
* (Optional) Algorithms that could be used to implement this feature
19+
* (Optional)Are there other libraries that implement this feature?
20+
-->

‎.github/ISSUE_TEMPLATE/performance_issue.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Performance Issue
3+
about: For Issues related to lackluster performance
4+
title: "[Perf]"
5+
labels: 'perf'
6+
assignees: ''
7+
8+
---
9+
10+
<!-- One or two line description of the performance issue -->
11+
12+
13+
Description
14+
===========
15+
16+
<!--
17+
* Additional information about the performance issues
18+
* Did you build ArrayFire yourself or did you use the official installers
19+
* Which backend is experiencing this issue? (CPU, CUDA, OpenCL)
20+
* Do you have a workaround?
21+
* Can the bug be reproduced reliably on your system?
22+
-->
23+
24+
Reproducible Code
25+
-----------------
26+
<!--
27+
* Provide a small example that could reproduce the performance issue
28+
* A full example will allow us to debug and fix this issue faster
29+
-->
30+
31+
System Information
32+
------------------
33+
ArrayFire Version:
34+
Device:
35+
Operating System:
36+
Driver version:
37+
38+
Checklist
39+
---------
40+
- [ ] I have read [timing ArrayFire](http://arrayfire.org/docs/timing.htm)

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Question
3+
about: General questions and potential issues
4+
title: "[Question]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Before asking a question on github, please consider if it is more appropriate for these other platforms:
11+
12+
* [Slack Chat](https://join.slack.com/t/arrayfire-org/shared_invite/MjI4MjIzMDMzMTczLTE1MDI5ODg4NzYtN2QwNGE3ODA5OQ)
13+
* [Google Groups](https://groups.google.com/forum/#!forum/arrayfire-users)
14+
* ArrayFire Services: [Consulting](http://arrayfire.com/consulting/) | [Support](http://arrayfire.com/support/) | [Training](http://arrayfire.com/training/)

0 commit comments

Comments
 (0)