diff --git a/.changeset/add-issue-templates.md b/.changeset/add-issue-templates.md new file mode 100644 index 00000000..e3a847b6 --- /dev/null +++ b/.changeset/add-issue-templates.md @@ -0,0 +1,5 @@ +--- +"@googleworkspace/cli": patch +--- + +Add GitHub issue templates for bug reports, feature requests, and documentation improvements diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..cba9d6ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,72 @@ +name: Bug Report +description: Report a bug or unexpected behavior +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug. Please fill out the sections below so we can reproduce and fix the issue. + + - type: input + id: version + attributes: + label: gws version + description: "Output of `gws --version`" + placeholder: "0.11.1" + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating System + options: + - macOS + - Linux + - Windows + - Other + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: A clear description of the bug. + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: Minimal steps to reproduce the behavior. + placeholder: | + 1. Run `gws ...` + 2. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What you expected to happen. + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened. Include the full error output if available. + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context — screenshots, environment variables, auth method, etc. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3afdfd9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Security Vulnerability + url: https://g.co/vulnz + about: Report security vulnerabilities through Google's vulnerability intake form diff --git a/.github/ISSUE_TEMPLATE/docs_improvement.yml b/.github/ISSUE_TEMPLATE/docs_improvement.yml new file mode 100644 index 00000000..65e63ca5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_improvement.yml @@ -0,0 +1,33 @@ +name: Documentation Improvement +description: Report missing, incorrect, or unclear documentation +labels: ["area: docs"] +body: + - type: markdown + attributes: + value: | + Help us improve the docs. Point us to what's missing, wrong, or confusing. + + - type: input + id: location + attributes: + label: Document or Section + description: Which file, page, or section needs improvement? + placeholder: "README.md > Authentication, skills/gws-gmail/SKILL.md, etc." + validations: + required: true + + - type: textarea + id: description + attributes: + label: What's Wrong or Missing + description: Describe the issue with the current documentation. + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested Improvement + description: How should the documentation be improved? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..3605b1da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,50 @@ +name: Feature Request +description: Suggest a new feature or improvement +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Have an idea for gws? Describe the problem you're trying to solve and the solution you'd like. + + - type: textarea + id: problem + attributes: + label: Problem + description: What problem does this feature solve? What's the use case? + placeholder: "I'm always frustrated when ..." + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the feature or change you'd like. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Any workarounds or alternative approaches you've tried. + validations: + required: false + + - type: dropdown + id: area + attributes: + label: Area + description: Which part of gws does this relate to? + options: + - CLI / core + - Authentication + - Discovery / commands + - Helper commands (+send, +append, etc.) + - Skills / agent integration + - Distribution / install + - Documentation + - Other + validations: + required: false