mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
Add community interaction files
- CONTRIBUTING.md: Comprehensive contributor guidelines - CHANGELOG.md: Version history and release notes - CODE_OF_CONDUCT.md: Community standards and behavior guidelines - SECURITY.md: Security policy and vulnerability reporting - GitHub issue templates: Bug reports, features, questions - Pull request template: Structured PR submissions Enhances community engagement and project governance. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
NomenAK
114
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
114
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,114 @@
|
||||
name: 🐛 Bug Report
|
||||
description: Report a bug or issue with SuperClaude
|
||||
title: "[Bug] "
|
||||
labels: ["bug", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting a bug! Please provide the following information to help us fix it.
|
||||
|
||||
- type: input
|
||||
id: superclaude-version
|
||||
attributes:
|
||||
label: SuperClaude Version
|
||||
description: What version of SuperClaude are you using?
|
||||
placeholder: v4.0.0
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: claude-code-version
|
||||
attributes:
|
||||
label: Claude Code Version
|
||||
description: What version of Claude Code are you using?
|
||||
placeholder: Latest
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: operating-system
|
||||
attributes:
|
||||
label: Operating System
|
||||
description: What operating system are you using?
|
||||
options:
|
||||
- macOS
|
||||
- Windows
|
||||
- Linux (Ubuntu)
|
||||
- Linux (Other)
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: bug-description
|
||||
attributes:
|
||||
label: Bug Description
|
||||
description: A clear and concise description of what the bug is.
|
||||
placeholder: Describe what happened...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduction-steps
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Steps to reproduce the behavior
|
||||
placeholder: |
|
||||
1. Run command: /user:analyze --code
|
||||
2. Open file X
|
||||
3. See error...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: What did you expect to happen?
|
||||
placeholder: Command should analyze code successfully...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual-behavior
|
||||
attributes:
|
||||
label: Actual Behavior
|
||||
description: What actually happened?
|
||||
placeholder: Command failed with error...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: error-messages
|
||||
attributes:
|
||||
label: Error Messages
|
||||
description: Include any error messages or logs
|
||||
placeholder: |
|
||||
```
|
||||
Error: Cannot find file...
|
||||
```
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context about the problem here
|
||||
placeholder: Screenshots, configuration files, etc.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Please confirm the following
|
||||
options:
|
||||
- label: I have searched for existing issues
|
||||
required: true
|
||||
- label: I have provided all required information
|
||||
required: true
|
||||
- label: I can reproduce this issue consistently
|
||||
required: false
|
||||
119
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
119
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,119 @@
|
||||
name: ✨ Feature Request
|
||||
description: Suggest a new feature or enhancement for SuperClaude
|
||||
title: "[Feature] "
|
||||
labels: ["enhancement", "needs-discussion"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for suggesting a feature! Please provide details to help us understand your request.
|
||||
|
||||
- type: dropdown
|
||||
id: feature-type
|
||||
attributes:
|
||||
label: Feature Type
|
||||
description: What type of feature are you requesting?
|
||||
options:
|
||||
- New Slash Command
|
||||
- New Persona
|
||||
- MCP Integration
|
||||
- Configuration Enhancement
|
||||
- Documentation Improvement
|
||||
- Installation/Setup
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem-description
|
||||
attributes:
|
||||
label: Problem Description
|
||||
description: What problem does this feature solve?
|
||||
placeholder: I'm frustrated when I try to... because...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposed-solution
|
||||
attributes:
|
||||
label: Proposed Solution
|
||||
description: Describe the solution you'd like to see
|
||||
placeholder: |
|
||||
I would like to see...
|
||||
|
||||
Example usage:
|
||||
/user:newcommand --flag
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternative-solutions
|
||||
attributes:
|
||||
label: Alternative Solutions
|
||||
description: Describe alternatives you've considered
|
||||
placeholder: I also considered... but it doesn't work because...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: use-cases
|
||||
attributes:
|
||||
label: Use Cases
|
||||
description: Describe specific scenarios where this would be useful
|
||||
placeholder: |
|
||||
1. When working on React projects...
|
||||
2. During code reviews...
|
||||
3. For debugging performance issues...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: examples
|
||||
attributes:
|
||||
label: Examples
|
||||
description: Provide concrete examples of how this feature would work
|
||||
placeholder: |
|
||||
Command: /user:example --new-flag
|
||||
Output: Expected behavior...
|
||||
|
||||
Persona usage:
|
||||
/persona:newtype → specialized behavior
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: Priority
|
||||
description: How important is this feature to you?
|
||||
options:
|
||||
- Nice to have
|
||||
- Would be helpful
|
||||
- Important for my workflow
|
||||
- Critical/Blocking
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context, screenshots, or examples
|
||||
placeholder: Links to similar features, mockups, related issues...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Please confirm the following
|
||||
options:
|
||||
- label: I have searched for existing feature requests
|
||||
required: true
|
||||
- label: I have provided a clear use case
|
||||
required: true
|
||||
- label: I'm willing to help test this feature
|
||||
required: false
|
||||
- label: I'm willing to help implement this feature
|
||||
required: false
|
||||
87
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
87
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
@@ -0,0 +1,87 @@
|
||||
name: ❓ Question
|
||||
description: Ask a question about SuperClaude usage or configuration
|
||||
title: "[Question] "
|
||||
labels: ["question", "help-wanted"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Have a question about SuperClaude? We're here to help!
|
||||
|
||||
**Tip:** Consider using [Discussions](../../discussions) for general questions and community help.
|
||||
|
||||
- type: dropdown
|
||||
id: question-type
|
||||
attributes:
|
||||
label: Question Type
|
||||
description: What type of question is this?
|
||||
options:
|
||||
- Installation/Setup
|
||||
- Command Usage
|
||||
- Persona Configuration
|
||||
- MCP Integration
|
||||
- Troubleshooting
|
||||
- Best Practices
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Your Question
|
||||
description: What would you like to know?
|
||||
placeholder: How do I... / Why does... / What's the best way to...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Context
|
||||
description: Provide context about what you're trying to achieve
|
||||
placeholder: |
|
||||
I'm trying to...
|
||||
My setup is...
|
||||
I've already tried...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: current-config
|
||||
attributes:
|
||||
label: Current Configuration
|
||||
description: Share relevant configuration or commands you're using
|
||||
placeholder: |
|
||||
```
|
||||
/user:command --flags
|
||||
Persona: architect
|
||||
Claude Code version: latest
|
||||
```
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: attempted-solutions
|
||||
attributes:
|
||||
label: What Have You Tried?
|
||||
description: What solutions have you already attempted?
|
||||
placeholder: |
|
||||
1. I tried reading the documentation...
|
||||
2. I searched for similar issues...
|
||||
3. I tested with different settings...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Please confirm the following
|
||||
options:
|
||||
- label: I have read the README.md
|
||||
required: true
|
||||
- label: I have searched existing issues and discussions
|
||||
required: true
|
||||
- label: This is not a bug report (use Bug Report template instead)
|
||||
required: true
|
||||
62
.github/pull_request_template.md
vendored
Normal file
62
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
# Pull Request
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| ✓ | completed | | PR | pull request |
|
||||
|
||||
## Summary
|
||||
Brief description of changes
|
||||
|
||||
## Type of Change
|
||||
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] ✨ New feature (non-breaking change which adds functionality)
|
||||
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] 📚 Documentation update
|
||||
- [ ] 🔧 Configuration change
|
||||
- [ ] 🎨 Code style/formatting change
|
||||
- [ ] ♻️ Refactoring (no functional changes)
|
||||
- [ ] ⚡ Performance improvement
|
||||
- [ ] 🔒 Security fix
|
||||
|
||||
## Changes Made
|
||||
- Change 1
|
||||
- Change 2
|
||||
- Change 3
|
||||
|
||||
## Testing
|
||||
- [ ] Tested install.sh on clean system
|
||||
- [ ] Verified slash commands work in Claude Code
|
||||
- [ ] Checked YAML syntax validity
|
||||
- [ ] Tested persona functionality
|
||||
- [ ] Tested MCP integration
|
||||
- [ ] Manual testing performed
|
||||
- [ ] All existing tests pass
|
||||
|
||||
## Related Issues
|
||||
Fixes #(issue number)
|
||||
Closes #(issue number)
|
||||
Related to #(issue number)
|
||||
|
||||
## Screenshots (if applicable)
|
||||
<!-- Add screenshots to demonstrate visual changes -->
|
||||
|
||||
## Checklist
|
||||
- [ ] My code follows the project's style guidelines
|
||||
- [ ] I have performed a self-review of my code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published
|
||||
|
||||
## Additional Notes
|
||||
<!-- Any additional information, concerns, or notes for reviewers -->
|
||||
|
||||
## Breaking Changes
|
||||
<!-- If this is a breaking change, describe what users need to do to migrate -->
|
||||
|
||||
---
|
||||
**Ready for review!** 🚀
|
||||
Reference in New Issue
Block a user