mirror of
https://github.com/XuehaiPan/nvitop.git
synced 2026-05-15 14:15:55 -06:00
chore(.github): update issue templates
Signed-off-by: Xuehai Pan <XuehaiPan@pku.edu.cn>
This commit is contained in:
Xuehai Pan
parent
487661f9a5
commit
7ba0bb2720
5 changed files with 248 additions and 59 deletions
59
.github/ISSUE_TEMPLATE.md
vendored
59
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,59 +0,0 @@
|
|||
<!--
|
||||
Thank you for contributing to nvitop by opening this issue.
|
||||
Please check through this list, so you can be as helpful as possible:
|
||||
|
||||
1. Was this issue already reported? Please do a quick search.
|
||||
2. Does reinstall `nvitop` in an isolated environment works?
|
||||
Have a try with `pipx run nvitop`.
|
||||
3. Maybe the problem is solved in the current master branch already?
|
||||
Simply clone nvitop's git repository and run `LOGLEVEL=DEBUG ./nvitop.py`
|
||||
to find out.
|
||||
4. Provide all the relevant information, as outlined in this template.
|
||||
Feel free to remove any sections you don't need.
|
||||
-->
|
||||
|
||||
#### Runtime Environment
|
||||
|
||||
- Operating system and version: [e.g. Ubuntu 20.04 LTS / Windows 10 Build 19043.1110]
|
||||
- Terminal emulator and version: [e.g. GNOME Terminal 3.36.2 / Windows Terminal 1.8.1521.0]
|
||||
- Python version: [e.g. `3.5.6` / `3.9.6`]
|
||||
- NVML version (driver version): [e.g. `460.84`]
|
||||
- `nvitop` version or commit: [e.g. `0.10.0` / `0.10.1.dev7+ga083321` / `main@75ae3c`]
|
||||
- `python-ml-py` version: [e.g. `11.450.51`]
|
||||
- Locale: [e.g. `C` / `C.UTF-8` / `en_US.UTF-8`]
|
||||
|
||||
#### Current Behavior
|
||||
|
||||
|
||||
|
||||
#### Expected Behavior
|
||||
|
||||
|
||||
|
||||
#### Context
|
||||
|
||||
<!-- How has this issue affected you? What are you trying to accomplish? -->
|
||||
|
||||
|
||||
#### Possible Solutions
|
||||
|
||||
<!-- Please feel free to delete this section if you are not sure. -->
|
||||
|
||||
|
||||
#### Steps to Reproduce
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
#### Traceback
|
||||
|
||||
<!-- If nvitop crashes, paste the traceback in the quotes below. -->
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
#### Images / Videos <!-- Only if relevant -->
|
||||
|
||||
<!-- Link or embed images and videos of screenshots, sketches etc. -->
|
||||
150
.github/ISSUE_TEMPLATE/bug-report.yaml
vendored
Normal file
150
.github/ISSUE_TEMPLATE/bug-report.yaml
vendored
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
name: 🐛 Bug Report
|
||||
description: File an issue about a bug.
|
||||
title: "[BUG] "
|
||||
labels: [bug]
|
||||
assignees: [XuehaiPan]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with `nvitop`.
|
||||
You may try the latest version of `nvitop` in an isolated environment with the following commands first:
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade pipx
|
||||
pipx run --spec git+https://github.com/XuehaiPan/nvitop.git nvitop
|
||||
```
|
||||
|
||||
- type: checkboxes
|
||||
id: steps
|
||||
attributes:
|
||||
label: Required prerequisites
|
||||
description: Make sure you've completed the following steps before submitting your issue -- thank you!
|
||||
options:
|
||||
- label: I have read the documentation <https://nvitop.readthedocs.io>.
|
||||
required: true
|
||||
- label: I have searched the [Issue Tracker](https://github.com/XuehaiPan/nvitop/issues) that this hasn't already been reported. (comment there if it has.)
|
||||
required: true
|
||||
- label: I have tried the latest version of nvitop in an new isolated virtual environment.
|
||||
required: false
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: |
|
||||
What version of nvitop are you using?
|
||||
value: |
|
||||
python3 -m pip show nvitop
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: system
|
||||
attributes:
|
||||
label: Operating system and version
|
||||
placeholder: E.g., Ubuntu 20.04 LTS / Windows 10 Build 19043.1110
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: driver-version
|
||||
attributes:
|
||||
label: NVIDIA driver version
|
||||
placeholder: E.g., 470.141.03
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: nvidia-smi
|
||||
attributes:
|
||||
label: NVIDIA-SMI
|
||||
placeholder: Run command `nvidia-smi` in your shell and paste the output here.
|
||||
render: text
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Python environment
|
||||
value: |
|
||||
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:
|
||||
|
||||
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
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Problem description
|
||||
placeholder: |
|
||||
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.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: code
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
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
|
||||
|
||||
```
|
||||
|
||||
Command lines:
|
||||
|
||||
```bash
|
||||
|
||||
```
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: traceback
|
||||
attributes:
|
||||
label: Traceback
|
||||
placeholder: |
|
||||
Put the Python traceback information here.
|
||||
|
||||
Traceback (most recent call last):
|
||||
File ...
|
||||
render: pytb
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs
|
||||
placeholder: |
|
||||
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.
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
placeholder: |
|
||||
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.
|
||||
1
.github/ISSUE_TEMPLATE/config.yaml
vendored
Normal file
1
.github/ISSUE_TEMPLATE/config.yaml
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
blank_issues_enabled: false
|
||||
59
.github/ISSUE_TEMPLATE/feature-request.yaml
vendored
Normal file
59
.github/ISSUE_TEMPLATE/feature-request.yaml
vendored
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
name: ✨ Feature Request
|
||||
description: Suggest an idea for this project.
|
||||
title: "[Feature Request] "
|
||||
labels: [enhancement]
|
||||
assignees: [XuehaiPan]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with `nvitop`.
|
||||
You may try the latest version of `nvitop` in an isolated environment with the following commands first:
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade pipx
|
||||
pipx run --spec git+https://github.com/XuehaiPan/nvitop.git nvitop
|
||||
```
|
||||
|
||||
- type: checkboxes
|
||||
id: steps
|
||||
attributes:
|
||||
label: Required prerequisites
|
||||
description: Make sure you've completed the following steps before submitting your issue -- thank you!
|
||||
options:
|
||||
- label: I have searched the [Issue Tracker](https://github.com/XuehaiPan/nvitop/issues) that this hasn't already been reported. (comment there if it has.)
|
||||
required: true
|
||||
- label: I have tried the latest version of nvitop in an new isolated virtual environment.
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: motivation
|
||||
attributes:
|
||||
label: Motivation
|
||||
value: |
|
||||
<!-- Please outline the motivation for the proposal.
|
||||
Is your feature request related to a problem? E.g., "I'm always frustrated when [...]".
|
||||
If this is related to another issue, please link here too. -->
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Solution
|
||||
placeholder: |
|
||||
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.
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
placeholder: |
|
||||
Add any other context about the problem here. Screenshots may also be helpful.
|
||||
38
.github/ISSUE_TEMPLATE/questions.yaml
vendored
Normal file
38
.github/ISSUE_TEMPLATE/questions.yaml
vendored
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
name: 🤔 Questions / Help / Support
|
||||
description: Do you need support?
|
||||
title: "[Question] "
|
||||
labels: [question]
|
||||
assignees: [XuehaiPan]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with `nvitop`.
|
||||
You may try the latest version of `nvitop` in an isolated environment with the following commands first:
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade pipx
|
||||
pipx run --spec git+https://github.com/XuehaiPan/nvitop.git nvitop
|
||||
```
|
||||
|
||||
- type: checkboxes
|
||||
id: steps
|
||||
attributes:
|
||||
label: Required prerequisites
|
||||
description: Make sure you've completed the following steps before submitting your issue -- thank you!
|
||||
options:
|
||||
- label: I have read the documentation <https://nvitop.readthedocs.io>.
|
||||
required: true
|
||||
- label: I have searched the [Issue Tracker](https://github.com/XuehaiPan/nvitop/issues) that this hasn't already been reported. (comment there if it has.)
|
||||
required: true
|
||||
- label: I have tried the latest version of nvitop in an new isolated virtual environment.
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: questions
|
||||
attributes:
|
||||
label: Questions
|
||||
placeholder: |
|
||||
Describe your questions with relevant resources such as snippets, links, images, etc.
|
||||
validations:
|
||||
required: true
|
||||
Loading…
Add table
Add a link
Reference in a new issue