chore(.github): update issue template

Signed-off-by: Xuehai Pan <XuehaiPan@pku.edu.cn>
This commit is contained in:
Xuehai Pan 2022-12-08 21:46:46 +08:00
parent 84b40be1e3
commit c04fbb9bbc
3 changed files with 24 additions and 30 deletions

View file

@ -31,10 +31,9 @@ body:
- type: input
id: version
attributes:
label: |
What version of nvitop are you using?
value: |
python3 -m pip show nvitop
label: What version of nvitop are you using?
description: Run command `nvitop --version` or `python3 -m nvitop --version` in your shell and paste the output here.
placeholder: E.g., 0.11.0
validations:
required: true
@ -50,7 +49,7 @@ body:
id: driver-version
attributes:
label: NVIDIA driver version
placeholder: E.g., 470.141.03
placeholder: E.g., 470.161.03
validations:
required: true
@ -58,24 +57,24 @@ body:
id: nvidia-smi
attributes:
label: NVIDIA-SMI
placeholder: Run command `nvidia-smi` in your shell and paste the output here.
description: Run command `nvidia-smi` in your shell and paste the output here.
render: text
- type: textarea
id: environment
attributes:
label: Python environment
value: |
description: |
Describe the characteristic of your environment:
- Describe how the library was installed (pip, conda, source, ...)
- Python version
- Versions of any other relevant libraries
```text
Run the following command (copy all of them) in your shell and paste the results here:
Run the following command (copy all of them) in your shell and paste the results in the textbox below.
python3 -m pip freeze | python3 -c 'import sys; print(sys.version, sys.platform); print("".join(filter(lambda s: any(word in s.lower() for word in ("nvi", "cuda", "nvml", "gpu")), sys.stdin)))'
```bash
python3 -m pip freeze | python3 -c 'import sys; print(sys.version, sys.platform); print("".join(filter(lambda s: any(word in s.lower() for word in ("nvi", "cuda", "nvml", "gpu")), sys.stdin)))'
```
validations:
required: true
@ -84,10 +83,11 @@ body:
id: description
attributes:
label: Problem description
placeholder: |
description: >-
Provide a short description, state the expected behavior and what actually happens. Include
relevant information like what version of nvitop you are using, what system you are on, and
any useful commands / output.
placeholder: Describe what the problem is.
validations:
required: true
@ -95,11 +95,11 @@ body:
id: code
attributes:
label: Steps to Reproduce
description: >-
The code should be minimal, have minimal external dependencies, and isolate the functions
that cause breakage. Submit matched and complete snippets that can be easily run to diagnose
the issue.
value: |
<!-- The code should be minimal, have minimal external dependencies, and isolate the
functions that cause breakage. Submit matched and complete snippets that can be easily
run to diagnose the issue. -->
The Python snippets (if any):
```python
@ -118,9 +118,8 @@ body:
id: traceback
attributes:
label: Traceback
description: Put the Python traceback information here.
placeholder: |
Put the Python traceback information here.
Traceback (most recent call last):
File ...
render: pytb
@ -129,22 +128,20 @@ body:
id: logs
attributes:
label: Logs
placeholder: |
Run nvitop with `LOGLEVEL=DEBUG nvitop` and paste the output here.
description: Run nvitop with `LOGLEVEL=DEBUG nvitop` and paste the output here.
render: text
- type: textarea
id: expected
attributes:
label: Expected behavior
placeholder: |
Provide a clear and concise description of what you expected to happen.
description: Provide a clear and concise description of what you expected to happen.
- type: textarea
id: additional-context
attributes:
label: Additional context
placeholder: |
description: >-
Add any other context about the problem here. Screenshots may also be helpful.
If you know or suspect the reason for this bug, paste the code lines and suggest modifications.

View file

@ -30,6 +30,7 @@ body:
id: motivation
attributes:
label: Motivation
description: Outline the motivation for the proposal.
value: |
<!-- Please outline the motivation for the proposal.
Is your feature request related to a problem? E.g., "I'm always frustrated when [...]".
@ -41,19 +42,16 @@ body:
id: solution
attributes:
label: Solution
placeholder: |
Provide a clear and concise description of what you want to happen.
description: Provide a clear and concise description of what you want to happen.
- type: textarea
id: alternatives
attributes:
label: Alternatives
placeholder: |
A clear and concise description of any alternative solutions or features you've considered.
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional-context
attributes:
label: Additional context
placeholder: |
Add any other context about the problem here. Screenshots may also be helpful.
description: Add any other context about the problem here. Screenshots may also be helpful.

View file

@ -32,7 +32,6 @@ body:
id: questions
attributes:
label: Questions
placeholder: |
Describe your questions with relevant resources such as snippets, links, images, etc.
description: Describe your questions with relevant resources such as snippets, links, images, etc.
validations:
required: true