From 2c78bb295888b439981cd2f0b6c24ed4665ad3bf Mon Sep 17 00:00:00 2001 From: Javier Martinez Date: Thu, 18 Jul 2024 12:56:10 +0200 Subject: [PATCH] docs: add PR and issue templates (#2002) * chore: add pull request template * chore: add issue templates * chore: require more information in bugs --- .github/ISSUE_TEMPLATE/bug.yml | 105 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/docs.yml | 19 +++++ .github/ISSUE_TEMPLATE/feature.yml | 37 ++++++++++ .github/ISSUE_TEMPLATE/question.yml | 19 +++++ .github/pull_request_template.md | 37 ++++++++++ 6 files changed, 225 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..7901a79ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,105 @@ +name: Bug Report +description: Report a bug or issue with the project. +title: "[BUG] " +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + **Please describe the bug you encountered.** + + - type: checkboxes + id: pre-check + attributes: + label: Pre-check + description: Please confirm that you have searched for duplicate issues before creating this one. + options: + - label: I have searched the existing issues and none cover this bug. + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Provide a detailed description of the bug. + placeholder: "Detailed description of the bug" + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Provide the steps to reproduce the bug. + placeholder: "1. Step one\n2. Step two\n3. Step three" + validations: + required: true + + - type: input + id: expected + attributes: + label: Expected Behavior + description: Describe what you expected to happen. + placeholder: "Expected behavior" + validations: + required: true + + - type: input + id: actual + attributes: + label: Actual Behavior + description: Describe what actually happened. + placeholder: "Actual behavior" + validations: + required: true + + - type: input + id: environment + attributes: + label: Environment + 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 + attributes: + label: Version + description: Provide the version of the project where you encountered the bug. + placeholder: "Version number" + + - 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`) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..eaae6e439 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Documentation + url: https://docs.privategpt.dev + about: Please refer to our documentation for more details and guidance. + - name: Discord + url: https://discord.gg/bK6mRVpErU + about: Join our Discord community to ask questions and get help. diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 000000000..e078bf2fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,19 @@ +name: Documentation +description: Suggest a change or addition to the documentation. +title: "[DOCS] " +labels: ["documentation"] + +body: + - type: markdown + attributes: + value: | + **Please describe the documentation change or addition you would like to suggest.** + + - type: textarea + id: description + attributes: + label: Description + description: Provide a detailed description of the documentation change. + placeholder: "Detailed description of the documentation change" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..648e19d21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,37 @@ +name: Enhancement +description: Suggest an enhancement or improvement to the project. +title: "[FEATURE] " +labels: ["enhancement"] + +body: + - type: markdown + attributes: + value: | + **Please describe the enhancement or improvement you would like to suggest.** + + - type: textarea + id: feature_description + attributes: + label: Feature Description + description: Provide a detailed description of the enhancement. + placeholder: "Detailed description of the enhancement" + validations: + required: true + + - type: textarea + id: reason + attributes: + label: Reason + description: Explain the reason for this enhancement. + placeholder: "Reason for the enhancement" + validations: + required: true + + - type: textarea + id: value + attributes: + label: Value of Feature + description: Describe the value or benefits this feature will bring. + placeholder: "Value or benefits of the feature" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..bfd3003c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,19 @@ +name: Question +description: Ask a question about the project. +title: "[QUESTION] " +labels: ["question"] + +body: + - type: markdown + attributes: + value: | + **Please describe your question in detail.** + + - type: textarea + id: question + attributes: + label: Question + description: Provide a detailed description of your question. + placeholder: "Detailed description of the question" + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..701ed1e31 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,37 @@ +# Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +## Type of Change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Added new unit/integration tests +- [ ] I stared at the code and made sure it makes sense + +**Test Configuration**: +* Firmware version: +* Hardware: +* Toolchain: +* SDK: + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] I ran `make check; make test` to ensure mypy and tests pass \ No newline at end of file