Skip to content

Commit 7bd8cb6

Browse files
9prady99prady9
committed
Add issue templates
1 parent b3a1915 commit 7bd8cb6

File tree

5 files changed

+169
-0
lines changed

5 files changed

+169
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

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

‎.github/ISSUE_TEMPLATE/build_error.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Build Error
3+
about: Create a report for errors during the crate build
4+
title: "[Build]"
5+
labels: 'Bug,Build'
6+
assignees: '9prady9'
7+
---
8+
9+
Description
10+
===========
11+
<!--
12+
A short one or two line description of the error
13+
-->
14+
15+
Build Environment
16+
-----------------
17+
Compiler version: <!-- MSVC v140 or gcc 9.3.2 -->
18+
Operating system: <!-- Windows 10; Ubuntu 18.04 -->
19+
Build environment: <!-- Environment variables; Installed software -->
20+
21+
Error Log
22+
---------
23+
<!-- Output of the error log. -->
24+
```
25+
26+
```

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new idea for Rust wrapper of ArrayFire
4+
title: 'Feature'
5+
labels: 'Feature'
6+
assignees: '9prady9'
7+
8+
---
9+
10+
Description
11+
===========
12+
<!--
13+
* If it is new function you want to add, please raise the feature request on [arrayfire](https://github.com/arrayfire/arrayfire/issues) repository.
14+
* If it is rust specific improvement or enhancement to existing feature, please explain the details.
15+
-->

‎.github/ISSUE_TEMPLATE/performance_issue.md

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