From c19dc32eb851f861a6e297dc4777e7ebcda502e0 Mon Sep 17 00:00:00 2001 From: Kristofers Solo Date: Thu, 12 Mar 2026 19:45:14 +0200 Subject: [PATCH] chore: add GitHub issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 63 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/documentation.yml | 27 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 33 ++++++++++++ 5 files changed, 163 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..1f78b31 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: Bug Report +description: Something isn't working as expected +labels: ["bug"] +assignees: [kristoferssolo] +body: + - type: markdown + attributes: + value: | + Before submitting, check [existing issues](../../issues) to avoid duplicates. + - type: input + id: typst-version + attributes: + label: Typst Version + description: Run `typst --version` + placeholder: "e.g. typst 0.14.0" + validations: + required: true + - type: input + id: template-version + attributes: + label: Template Version + description: Release tag or commit hash + placeholder: "e.g. v1.0.0 or a3f5c2d" + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Clear and concise description of the bug. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Minimal Reproduction + description: > + A minimal `.typ` snippet that reproduces the issue. Remove everything not necessary to trigger the bug. + + render: typst + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual Behavior + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Context + description: > + Screenshots, PDF output snippets, compiler errors, or anything else relevant. + + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..dc8545b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,27 @@ +name: Documentation +description: Missing, incorrect, or unclear documentation +labels: ["documentation"] +assignees: [kristoferssolo] +body: + - type: input + id: location + attributes: + label: Location + description: File, section, or page where the issue is. + placeholder: "e.g. README.md > Usage, or docs/structure.md" + validations: + required: true + - type: textarea + id: description + attributes: + label: What's Wrong + description: What is missing, incorrect, or unclear? + validations: + required: true + - type: textarea + id: suggestion + attributes: + label: Suggested Improvement + description: How should it read or what should be added? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..e780c86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature Request +description: Suggest new functionality or an enhancement +labels: ["feature"] +assignees: [kristoferssolo] +body: + - type: markdown + attributes: + value: | + Before submitting, check [existing issues](../../issues) to avoid duplicates. + - type: textarea + id: problem + attributes: + label: Problem / Motivation + description: What problem does this solve? Why is it needed? + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the feature and how it should work. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Any workarounds or other approaches you've considered. + validations: + required: false + - type: checkboxes + id: lu-scope + attributes: + label: Scope + options: + - label: > + This is required or implied by University of Latvia thesis guidelines + + - label: This is a general usability or quality-of-life improvement diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..953a1f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,33 @@ +name: Question +description: Ask a question about using the template +labels: ["question"] +assignees: [kristoferssolo] +body: + - type: markdown + attributes: + value: | + Check the [README](../../blob/main/README.md) and + [existing issues](../../issues) first. + - type: textarea + id: question + attributes: + label: Question + validations: + required: true + - type: textarea + id: context + attributes: + label: Context + description: > + What are you trying to achieve? What have you already tried? + + validations: + required: false + - type: input + id: typst-version + attributes: + label: Typst Version + description: If relevant, run `typst --version` + placeholder: "e.g. typst 0.14.0" + validations: + required: false