From 08d283b4ec316a527badf4543a8f6eb5c3a090a2 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Tue, 26 Nov 2024 16:02:21 -0600 Subject: [PATCH] Add templates --- .github/ISSUE_TEMPLATE/1_bug_report.yaml | 34 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2_feature_request.yaml | 23 +++++++++++++ .github/ISSUE_TEMPLATE/3_question.yaml | 31 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++++ 4 files changed, 96 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/3_question.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yaml b/.github/ISSUE_TEMPLATE/1_bug_report.yaml new file mode 100644 index 0000000000000..b5beb8e10aef3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yaml @@ -0,0 +1,34 @@ +name: Bug report +description: Report an error or unexpected behavior +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + **Please review [our guide on interacting with the issue tracker](https://github.com/astral-sh/uv/issues/9452) before opening a new issue.** + + - type: textarea + attributes: + label: Summary + description: | + A clear and concise description of the bug, including [a minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). + If we cannot reproduce the bug, it is unlikely that we will be able to help you. + validations: + required: true + + - type: input + attributes: + label: Platform + description: What operating system and architecture are you using? + placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64, ... + validations: + required: true + + - type: input + attributes: + label: Version + description: What version of uv are you using? + placeholder: e.g., uv 0.5.20 (1c17662b3 2025-01-15) + validations: + required: true + diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yaml b/.github/ISSUE_TEMPLATE/2_feature_request.yaml new file mode 100644 index 0000000000000..4760b5c6ff622 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yaml @@ -0,0 +1,23 @@ +name: Feature request +description: Suggest a new feature or improvement +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + **Please review our [issue tracker guide](https://github.com/astral-sh/uv/issues/9452) before opening a new issue.** + + - type: textarea + attributes: + label: Summary + description: | + A clear and concise description of what new feature or behavior you would like to see. If applicable, please describe the current behavior as well. + validations: + required: true + + - type: textarea + attributes: + label: Example + description: Provide an example of how the user experience would change or how the new feature would be used. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/3_question.yaml b/.github/ISSUE_TEMPLATE/3_question.yaml new file mode 100644 index 0000000000000..91b51e220c030 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_question.yaml @@ -0,0 +1,31 @@ +name: Question +description: Ask a question about uv +labels: ["question"] +body: + - type: markdown + attributes: + value: | + **Please review our [issue tracker guide](https://github.com/astral-sh/uv/issues/9452) before opening a new issue.** + + - type: textarea + attributes: + label: Question + description: Describe your question in detail. + validations: + required: true + + - type: input + attributes: + label: Platform + description: What operating system and architecture are you using? + placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64, ... + validations: + required: false + + - type: input + attributes: + label: Version + description: What version of uv are you using? + placeholder: e.g., uv 0.5.20 (1c17662b3 2025-01-15) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000000..c4ccbc4adb247 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Read the documentation + url: https://docs.astral.sh/uv + about: Please consult the documentation before creating an issue. + - name: Join the community + url: https://discord.com/invite/astral-sh + about: Join our Discord community to ask questions and collaborate.