From a219409c28601e4c343a95138e59b1605779d022 Mon Sep 17 00:00:00 2001 From: Taylor Fore Date: Tue, 5 Nov 2024 09:47:27 -0600 Subject: [PATCH] chore: add issue templates and code owners (#1) --- .github/CODEOWNERS | 8 ++++ .github/ISSUE_TEMPLATE/bug_report.yml | 43 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 + .github/ISSUE_TEMPLATE/feature_request.yml | 35 ++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 27 ++++++++++++++ 5 files changed, 115 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..88299bd --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,8 @@ +# These owners will be the default owners for everything in +# the repo. Unless a later match takes precedence, +# these will be requested for review when someone opens a pull request. +* @trfore + +# The following own any files in the .github directory at the root of the +# repository and any of its subdirectories. +.github/ @trfore diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3c42e1a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,43 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +assignees: + - trfore +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + + - type: textarea + id: shell-code + attributes: + label: Relevant code + description: Please copy and paste any relevant shell code. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: input + id: proxmox-version + attributes: + label: Proxmox version + description: What version of Proxmox are you running? Please paste the output of `pveversion` + placeholder: "pve-manager/7.4-17/513c62be (running kernel: 5.15.149-1-pve)" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..bd9dfe4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +--- +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..e528103 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,35 @@ +--- +name: Feature request +description: Suggest an idea for this project +title: "[Feature]: " +labels: ["enhancement"] +assignees: + - trfore +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest new features! + - type: textarea + id: problem-statement + attributes: + label: General problem or idea + description: Is your feature request related to a problem? Please describe. + placeholder: "Example: I'm always frustrated when ..." + validations: + required: true + - type: textarea + id: solution-statement + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + - type: textarea + id: alternative-solutions + attributes: + label: Describe alternatives 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 + description: Add any other context about the feature request. diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..1809148 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,27 @@ +name: Question +description: Ask a question +title: "[Question]: " +labels: ["question"] +assignees: + - trfore +body: + - type: textarea + id: general + attributes: + label: Question + placeholder: What's your question? + validations: + required: true + + - type: textarea + id: shell-code + attributes: + label: Relevant code + description: Please copy and paste any relevant shell code. This will be automatically formatted into code, so no need for backticks. + render: bash + + - type: input + id: proxmox-version + attributes: + label: Proxmox version + description: What version of Proxmox are you running?