diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml new file mode 100644 index 000000000..519a338b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -0,0 +1,59 @@ +name: Bug report +description: Something is not working as it should. +labels: ["bug"] +body: + - type: dropdown + id: component + attributes: + label: Component + options: + - EC2 / instances + - EBS / volumes + - S3 / object store + - VPC / networking + - IAM / authentication + - EKS + - API gateway + - Web UI + - CLI / daemon + - Observability / telemetry + - Build / CI / packaging + - Documentation + - Other / not sure + validations: + required: true + + - type: input + id: version + attributes: + label: Spinifex version + description: Output of `spinifex --version`, or the commit SHA you are on. + placeholder: v1.0.0, or commit abc1234 + validations: + required: true + + - type: textarea + id: what-happened + attributes: + label: What happened + description: What you saw, what you expected instead, and how to reproduce it. + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs and output + description: Relevant log lines, error messages or command output. + render: shell + + - type: textarea + id: platform + attributes: + label: Platform + description: Where you are running it, and how you deployed it. + placeholder: | + OS: Debian 13 + Kernel: 6.12 + Arch: amd64 + Deployment: single node, systemd diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml new file mode 100644 index 000000000..39dc60a1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -0,0 +1,32 @@ +name: Feature request +description: Suggest something new. +labels: ["enhancement"] +body: + - type: dropdown + id: component + attributes: + label: Component + options: + - EC2 / instances + - EBS / volumes + - S3 / object store + - VPC / networking + - IAM / authentication + - EKS + - API gateway + - Web UI + - CLI / daemon + - Observability / telemetry + - Build / CI / packaging + - Documentation + - Other / not sure + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: What would you like to see? + description: What you are trying to do, and what stops you today. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3-docs.yml b/.github/ISSUE_TEMPLATE/3-docs.yml new file mode 100644 index 000000000..840e99d47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-docs.yml @@ -0,0 +1,20 @@ +name: Documentation +description: Something in the docs is wrong, missing or unclear. +labels: ["documentation"] +body: + - type: input + id: location + attributes: + label: Where + description: Link to the page, or the path to the file in this repository. + placeholder: https://docs.mulgadc.com/..., or README.md + validations: + required: true + + - type: textarea + id: problem + attributes: + label: What is wrong + description: What is inaccurate, missing or confusing, and what it should say instead. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..313eb7230 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Documentation + url: https://docs.mulgadc.com + about: Guides, configuration reference and API compatibility notes. + - name: Report a security vulnerability + url: https://github.com/mulgadc/spinifex/security/advisories/new + about: Report privately. Please do not open a public issue for a vulnerability.