diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index c934251f..7901a79c 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -58,8 +58,17 @@ body: id: environment attributes: label: Environment - description: Provide details about your environment (e.g., OS, browser, Node version). + description: Provide details about your environment (e.g., OS, GPU, profile, etc.). placeholder: "Environment details" + validations: + required: true + + - type: input + id: additional + attributes: + label: Additional Information + description: Provide any additional information that may be relevant (e.g., logs, screenshots). + placeholder: "Any additional information that may be relevant" - type: input id: version @@ -67,5 +76,30 @@ body: label: Version description: Provide the version of the project where you encountered the bug. placeholder: "Version number" - validations: - required: true + + - type: markdown + attributes: + value: | + **Please ensure the following setup checklist has been reviewed before submitting the bug report.** + + - type: checkboxes + id: general-setup-checklist + attributes: + label: Setup Checklist + description: Verify the following general aspects of your setup. + options: + - label: Confirm that you have followed the installation instructions in the project’s documentation. + - label: Check that you are using the latest version of the project. + - label: Verify disk space availability for model storage and data processing. + - label: Ensure that you have the necessary permissions to run the project. + + - type: checkboxes + id: nvidia-setup-checklist + attributes: + label: NVIDIA GPU Setup Checklist + description: Verify the following aspects of your NVIDIA GPU setup. + options: + - label: Check that the all CUDA dependencies are installed and are compatible with your GPU (refer to [CUDA's documentation](https://docs.nvidia.com/deploy/cuda-compatibility/#frequently-asked-questions)) + - label: Ensure an NVIDIA GPU is installed and recognized by the system (run `nvidia-smi` to verify). + - label: Ensure proper permissions are set for accessing GPU resources. + - label: Docker users - Verify that the NVIDIA Container Toolkit is configured correctly (e.g. run `sudo docker run --rm --gpus all nvidia/cuda:11.0.3-base-ubuntu20.04 nvidia-smi`)