feat: add GitHub issue form templates
4 YAML form templates for structured feedback from the landing site FAB: - bug_report.yml: page URL, browser, OS, steps, expected vs actual (update of existing) - content_suggestion.yml: type, section, description, references - quiz_error.yml: question ID, category, error type, suggested fix - general_feedback.yml: type (UX/content/a11y/perf), message, page URL - config.yml: blank_issues_enabled + Discussions link Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
5083d80ed1
commit
4c42151151
4 changed files with 180 additions and 0 deletions
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Ask a question
|
||||
url: https://github.com/FlorianBruniaux/claude-code-ultimate-guide/discussions
|
||||
about: Use Discussions for questions and general conversation about the guide.
|
||||
63
.github/ISSUE_TEMPLATE/content_suggestion.yml
vendored
Normal file
63
.github/ISSUE_TEMPLATE/content_suggestion.yml
vendored
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
name: Content Suggestion
|
||||
description: Suggest new content, an update, or a correction to the guide
|
||||
title: "[Content]: "
|
||||
labels: ["content"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for helping improve the guide! Your suggestion matters.
|
||||
|
||||
- type: dropdown
|
||||
id: type
|
||||
attributes:
|
||||
label: Type of suggestion
|
||||
options:
|
||||
- New content
|
||||
- Update existing content
|
||||
- Correction (factual error)
|
||||
- Improve clarity
|
||||
- Add example
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: section
|
||||
attributes:
|
||||
label: Guide section
|
||||
description: Which section does this relate to?
|
||||
options:
|
||||
- Getting Started
|
||||
- Installation & Setup
|
||||
- Configuration
|
||||
- MCP Servers
|
||||
- Tools & Commands
|
||||
- Best Practices
|
||||
- Security
|
||||
- Agent Teams
|
||||
- Advanced Topics
|
||||
- Examples & Templates
|
||||
- Cheatsheet
|
||||
- Quiz
|
||||
- Other / New section
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: What should be added, updated, or corrected?
|
||||
placeholder: "The guide is missing X. It would be useful because..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: references
|
||||
attributes:
|
||||
label: References (optional)
|
||||
description: Links to official docs, blog posts, or sources that support your suggestion
|
||||
placeholder: "https://docs.anthropic.com/..."
|
||||
validations:
|
||||
required: false
|
||||
42
.github/ISSUE_TEMPLATE/general_feedback.yml
vendored
Normal file
42
.github/ISSUE_TEMPLATE/general_feedback.yml
vendored
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
name: General Feedback
|
||||
description: Share general feedback about the guide, site UX, or accessibility
|
||||
title: "[Feedback]: "
|
||||
labels: ["feedback"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
All feedback is welcome — from quick thoughts to detailed suggestions.
|
||||
|
||||
- type: dropdown
|
||||
id: type
|
||||
attributes:
|
||||
label: Feedback type
|
||||
options:
|
||||
- Site UX / Navigation
|
||||
- Content quality
|
||||
- Accessibility
|
||||
- Performance
|
||||
- Feature request
|
||||
- Compliment / kudos
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: message
|
||||
attributes:
|
||||
label: Your feedback
|
||||
description: Share whatever is on your mind
|
||||
placeholder: "I think the guide would be better if..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: page
|
||||
attributes:
|
||||
label: Page URL (optional)
|
||||
description: Which page does your feedback relate to?
|
||||
placeholder: "https://cc.bruniaux.com/..."
|
||||
validations:
|
||||
required: false
|
||||
70
.github/ISSUE_TEMPLATE/quiz_error.yml
vendored
Normal file
70
.github/ISSUE_TEMPLATE/quiz_error.yml
vendored
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
name: Quiz Issue
|
||||
description: Report an error in a quiz question (wrong answer, typo, outdated content)
|
||||
title: "[Quiz]: "
|
||||
labels: ["quiz"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Found a problem in the quiz? Help us fix it!
|
||||
|
||||
- type: input
|
||||
id: question_id
|
||||
attributes:
|
||||
label: Question ID
|
||||
description: The ID shown in the quiz (e.g. 01-042)
|
||||
placeholder: "XX-YYY"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: category
|
||||
attributes:
|
||||
label: Category
|
||||
options:
|
||||
- Quick Start
|
||||
- Configuration
|
||||
- Tools & Commands
|
||||
- MCP Servers
|
||||
- Best Practices
|
||||
- Security
|
||||
- Agent Teams
|
||||
- Advanced Topics
|
||||
- Git & Workflows
|
||||
- Performance
|
||||
- Debugging
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: error_type
|
||||
attributes:
|
||||
label: Type of issue
|
||||
options:
|
||||
- Wrong correct answer marked
|
||||
- All answer options are incorrect
|
||||
- Question is outdated (Claude Code changed)
|
||||
- Typo or grammar error
|
||||
- Confusing or ambiguous wording
|
||||
- Missing context in explanation
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Describe the issue
|
||||
description: What's wrong and what should it say instead?
|
||||
placeholder: "The question says X is correct, but actually Y is correct because..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: suggested_fix
|
||||
attributes:
|
||||
label: Suggested fix (optional)
|
||||
description: If you know the correct answer or fix, share it here
|
||||
validations:
|
||||
required: false
|
||||
Loading…
Add table
Add a link
Reference in a new issue