diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e7d288f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,43 @@ +--- +name: Bug Report +about: Report an issue with an example, guide, or documentation +title: "[BUG] " +labels: bug +assignees: '' + +--- + +## Description +Brief description of the issue. + +## Steps to Reproduce +1. Step 1 +2. Step 2 +3. Step 3 + +## Expected Behavior +What should happen? + +## Actual Behavior +What actually happened? + +## Environment +- **Claude Code Version**: (e.g., 1.0.5) +- **Operating System**: (e.g., macOS 14.1, Ubuntu 22.04, Windows 11) +- **Python Version**: (if relevant, e.g., 3.11) +- **Affected Component**: (e.g., 01-slash-commands, 03-skills, etc.) + +## Example Code +If applicable, provide the example code that's not working: +``` +[Insert code here] +``` + +## Screenshots +If applicable, add screenshots showing the issue. + +## Additional Context +Any other context that might help us understand the issue? + +## Possible Solution +If you have a suggestion for fixing this, share it here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..014f61e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Claude Code Documentation + url: https://docs.anthropic.com/en/docs/claude-code + about: Official Claude Code documentation + - name: Discussions + url: https://github.com/luongnv89/claude-howto/discussions + about: Ask questions and share ideas with the community + - name: Claude Code Examples + url: https://github.com/anthropic/claude-examples + about: Official Claude Code examples from Anthropic diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..856f168 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,44 @@ +--- +name: Documentation Issue +about: Report unclear documentation, typos, or missing information +title: "[DOCS] " +labels: documentation +assignees: '' + +--- + +## Type of Issue +- [ ] Typo or grammar error +- [ ] Unclear explanation +- [ ] Missing information +- [ ] Broken link or reference +- [ ] Outdated content +- [ ] Better example needed + +## Location +Which section has the issue? +- **File**: (e.g., README.md, 03-skills/README.md) +- **Section**: (e.g., "Installation Quick Reference") +- **Line/Area**: (if specific) + +## Current Content +What does it currently say? +``` +[Paste the current text here] +``` + +## Issue Description +What's wrong with it? + +## Suggested Improvement +How could this be improved or clarified? +``` +[Provide improved text or suggestion here] +``` + +## Why This Matters +How does this issue impact users? + +## Related Documentation +Links to related sections: +- [Related Guide](link) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..453f870 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,46 @@ +--- +name: Feature Request +about: Suggest a new example, guide, or improvement +title: "[FEATURE] " +labels: enhancement +assignees: '' + +--- + +## Description +Describe the feature or improvement you'd like to see. + +## Problem It Solves +What problem or gap does this address? + +Examples: +- There's no example of X feature +- The current documentation for Y is unclear +- We need a guide for Z use case +- The structure could be improved by... + +## Use Case +When and how would this be used? Include real-world scenarios. + +## Proposed Solution +How should this be implemented or documented? + +## Example +If applicable, provide an example of what you envision: +``` +[Insert example here] +``` + +## Related Examples +Link any existing related examples or guides: +- [Existing Guide](link) +- Feature: (e.g., Skills, Hooks, Subagents) + +## Additional Context +Any other information that might be helpful? + +## Acceptance Criteria +How would you know this feature is complete? +- [ ] Criterion 1 +- [ ] Criterion 2 +- [ ] Criterion 3 diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..ad5d99d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,40 @@ +--- +name: Question +about: Ask a question about Claude Code or this guide +title: "[QUESTION] " +labels: question +assignees: '' + +--- + +## Question +What would you like to know? + +## Context +Provide some background or context for your question: +- What are you trying to do? +- What have you already tried? +- What examples or guides have you looked at? + +## Relevant Topic +Which topic is this related to? +- [ ] Slash Commands +- [ ] Memory +- [ ] Skills +- [ ] Subagents +- [ ] MCP Protocol +- [ ] Hooks +- [ ] Plugins +- [ ] Checkpoints +- [ ] Advanced Features +- [ ] CLI Reference +- [ ] Other + +## What You've Tried +Have you already tried anything? What was the result? + +## Expected Outcome +What would help you solve this? + +## Additional Resources +Any links or resources that might be relevant? diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..f2deaae --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,57 @@ +## Description +Brief summary of what this PR does. + +## Type of Change +- [ ] New example or template +- [ ] Documentation improvement +- [ ] Bug fix +- [ ] Feature guide +- [ ] Other (please describe) + +## Related Issues +Closes #(issue number) + +## Changes Made +- Change 1 +- Change 2 +- Change 3 + +## What to Review +What should reviewers focus on? + +## Files Changed +- `path/to/file1.md` +- `path/to/file2.md` + +## Testing +How have you tested this? +- [ ] Tested locally with Claude Code +- [ ] Verified examples work +- [ ] Checked links and references +- [ ] Reviewed for typos and clarity + +## Checklist +- [ ] Follows project structure and conventions +- [ ] Includes clear documentation/examples +- [ ] Code/examples are copy-paste ready +- [ ] All links are verified and working +- [ ] No sensitive information included (keys, tokens, credentials) +- [ ] Updated relevant README files +- [ ] Commit message follows conventional commit format +- [ ] No large files (>1MB) added + +## Screenshots or Examples +If applicable, show what this adds: +``` +[Example code or before/after comparison] +``` + +## Breaking Changes +Does this change any existing content or behavior? +- [ ] No breaking changes +- [ ] Yes, and it's documented below + +If yes, please describe: + +## Additional Notes +Any other information for reviewers?