Commit 9196f35c authored by w8385's avatar w8385
Browse files

Create Issue and Pull Request Templates

parent c1ebeed9
Loading
Loading
Loading
Loading
+58 −0
Original line number Diff line number Diff line
name: "Bug Report"
description: "Report a bug or unexpected behavior"
labels: [ "type/bug" ]
body:
  - type: markdown
    attributes:
      value: |
        Please fill out the sections below to help us reproduce and fix the issue.

  - type: input
    attributes:
      label: Summary
      description: Describe the issue you're reporting.
    validations:
      required: true

  - type: textarea
    attributes:
      label: Expected Behavior
      description: What did you expect to happen?
    validations:
      required: true

  - type: textarea
    attributes:
      label: Actual Behavior
      description: What actually happened?
    validations:
      required: true

  - type: textarea
    attributes:
      label: Environment
      description: |
        Specify your runtime and operating system.
        - OS:
        - Runtime (Deno / Node.js / Bun / Cloudflare Workers):
        - Runtime version:
    validations:
      required: true

  - type: textarea
    attributes:
      label: Logs / Screenshots
      description: Paste logs or add screenshots to help us diagnose the issue.
    validations:
      required: false

  - type: textarea
    attributes:
      label: Steps to Reproduce
      description: Provide a step-by-step guide to reproduce the issue.
      placeholder: |
        1.
        2.
        3.
    validations:
      required: true
+43 −0
Original line number Diff line number Diff line
name: "Documentation Issue"
description: "Report missing, incorrect, or outdated documentation"
labels: [ "type/documentation" ]
body:
  - type: markdown
    attributes:
      value: |
        Please use this template to report issues or suggestions related to the documentation.

  - type: input
    attributes:
      label: Summary
      description: Briefly describe the documentation issue.
    validations:
      required: true

  - type: input
    attributes:
      label: Affected Docs
      description: Specify which documentation needs changes (file, section, etc.).
    validations:
      required: true

  - type: textarea
    attributes:
      label: What's Missing or Incorrect?
      description: Describe the issue with the current documentation.
    validations:
      required: true

  - type: textarea
    attributes:
      label: Suggested Content or Structure
      description: Suggest how the content or structure should be updated.
    validations:
      required: false

  - type: textarea
    attributes:
      label: Related Code / Feature
      description: Reference any related code or features, if relevant.
    validations:
      required: false
+43 −0
Original line number Diff line number Diff line
name: "Feature / Enhancement Issue"
description: "Suggest a new feature or improvement"
labels: [ "type/feature", "type/enhancement" ]
body:
  - type: markdown
    attributes:
      value: |
        Please fill out the following sections to help us understand your feature request.

  - type: input
    attributes:
      label: Summary
      description: Briefly describe the feature or enhancement you're suggesting.
    validations:
      required: true

  - type: textarea
    attributes:
      label: Problem
      description: Why is this needed? What problem does it solve?
    validations:
      required: true

  - type: textarea
    attributes:
      label: Proposed Solution
      description: Describe your suggested solution or behavior.
    validations:
      required: true

  - type: textarea
    attributes:
      label: Alternatives Considered
      description: Have you thought of other approaches or solutions?
    validations:
      required: false

  - type: textarea
    attributes:
      label: Scope / Dependencies
      description: What parts of the system would be affected or require changes?
    validations:
      required: false
+37 −0
Original line number Diff line number Diff line
name: "Maintenance / Chore Issue"
description: "Track maintenance tasks, build updates, or CI/CD improvements"
labels: [ "type/maintenance", "type/chore" ]
body:
  - type: markdown
    attributes:
      value: |
        Please use this template to describe maintenance or non-functional tasks.

  - type: input
    attributes:
      label: Summary
      description: Briefly describe the task or change you're proposing.
    validations:
      required: true

  - type: input
    attributes:
      label: Affected Area
      description: What part of the system or tooling is involved?
    validations:
      required: false

  - type: textarea
    attributes:
      label: Reason / Context
      description: Why is this task necessary? Include any relevant background.
    validations:
      required: false

  - type: checkboxes
    attributes:
      label: Checklist
      description: Steps to complete this task.
      options:
        - label: Step 1
        - label: Step 2
+43 −0
Original line number Diff line number Diff line
name: "Refactor / Performance / Test Issue"
description: "Suggest internal code improvements, optimizations, or test updates"
labels: [ "type/refactor", "type/performance", "type/test" ]
body:
  - type: markdown
    attributes:
      value: |
        Please provide the following details to help evaluate and prioritize this internal change.

  - type: input
    attributes:
      label: Summary
      description: Briefly describe the change you're proposing.
    validations:
      required: true

  - type: input
    attributes:
      label: Target Area
      description: Which part of the codebase is affected?
    validations:
      required: true

  - type: textarea
    attributes:
      label: Motivation
      description: Why does this change matter? What are you trying to improve?
    validations:
      required: true

  - type: textarea
    attributes:
      label: Risk Assessment
      description: Is there any risk of regressions or unintended side effects?
    validations:
      required: false

  - type: textarea
    attributes:
      label: Benefits
      description: What should be improved, simplified, or resolved as a result?
    validations:
      required: false
Loading