Skip to content

Commit 203140b

Browse files
author
echoVic
committed
docs: 添加项目文档和代理配置文件
添加完整的用户文档系统,包括快速开始指南、配置说明和使用手册。同时添加.claude/agents目录下的专业代理配置文件,涵盖多种技术领域的专业代理配置模板。 文档内容包括: - 项目介绍和核心特性 - 安装和快速开始指南 - 配置系统说明(主题、权限等) - 使用指南(Slash命令、Subagents系统等) - 参考文档(CLI命令、工具列表) 代理配置文件包含: - 多种技术领域的专业代理模板(前端、后端、AI、数据库等) - 每个代理的详细描述和使用指南 - 代理的输入输出规范和最佳实践
1 parent 83cb4c5 commit 203140b

109 files changed

Lines changed: 5141 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/agents

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
### Acceptable Behavior
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
18+
- Contributing constructively to discussions about AI agents and development
19+
20+
### Unacceptable Behavior
21+
22+
The following behaviors are considered harassment and are unacceptable:
23+
24+
- **Hate speech**: The use of abusive or threatening speech that expresses prejudice against a particular group, especially on the basis of race, religion, gender, sexual orientation, or other characteristics
25+
- **Discriminatory language**: Slurs, offensive comments, or language targeting protected characteristics
26+
- **Personal attacks**: Insulting, demeaning, or hostile comments directed at individuals
27+
- **Harassment**: Deliberate intimidation, stalking, following, or threatening
28+
- **Doxxing**: Publishing private information without consent
29+
- **Spam**: Excessive off-topic content, promotional material, or repetitive posts
30+
- **Trolling**: Deliberately inflammatory or disruptive behavior
31+
- **Sexual harassment**: Unwelcome sexual attention or advances
32+
33+
## Enforcement
34+
35+
### Reporting
36+
37+
If you experience or witness unacceptable behavior, please report it by:
38+
- Creating an issue with the `moderation` label
39+
- Contacting the repository maintainers directly
40+
- Using GitHub's built-in reporting mechanisms
41+
42+
### Consequences
43+
44+
Community leaders will follow these guidelines in determining consequences:
45+
46+
1. **Warning**: First offense or minor violation
47+
2. **Temporary restriction**: Temporary loss of interaction privileges
48+
3. **Permanent ban**: Severe or repeated violations
49+
50+
### Enforcement Actions
51+
52+
- **Immediate removal**: Hate speech, threats, or doxxing will result in immediate content removal and user blocking
53+
- **Issue/PR closure**: Inappropriate content will be closed and locked
54+
- **Account blocking**: Repeat offenders will be blocked from the repository
55+
56+
## Scope
57+
58+
This Code of Conduct applies within all community spaces, including:
59+
- Issues and pull requests
60+
- Discussions and comments
61+
- Wiki and documentation
62+
- External representations of the project
63+
64+
## Attribution
65+
66+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
67+
68+
## Contact
69+
70+
Questions about the Code of Conduct can be directed to the repository maintainers through GitHub issues or discussions.
Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Contributing to Agents
2+
3+
Thank you for your interest in contributing to this collection of Claude Code subagents! This guide will help you contribute effectively while maintaining a positive community environment.
4+
5+
## Before You Contribute
6+
7+
1. **Read our [Code of Conduct](.github/CODE_OF_CONDUCT.md)** - All interactions must follow our community standards
8+
2. **Search existing issues** - Check if your suggestion or bug report already exists
9+
3. **Use appropriate templates** - Follow the provided issue and PR templates
10+
11+
## Types of Contributions
12+
13+
### Subagent Improvements
14+
- Bug fixes in existing agent prompts
15+
- Performance optimizations
16+
- Enhanced capabilities or instructions
17+
- Documentation improvements
18+
19+
### New Subagents
20+
- Well-defined specialized agents for specific domains
21+
- Clear use cases and examples
22+
- Comprehensive documentation
23+
- Integration with existing workflows
24+
25+
### Infrastructure
26+
- GitHub Actions improvements
27+
- Template enhancements
28+
- Community tooling
29+
30+
## Contribution Process
31+
32+
### 1. Issues First
33+
- **Always create an issue before starting work** on significant changes
34+
- Use the appropriate issue template
35+
- Provide clear, detailed descriptions
36+
- Include relevant examples or use cases
37+
38+
### 2. Pull Requests
39+
- Fork the repository and create a feature branch
40+
- Follow existing code style and formatting
41+
- Include tests or examples where appropriate
42+
- Reference the related issue in your PR description
43+
- Use clear, descriptive commit messages
44+
45+
### 3. Review Process
46+
- All PRs require review from maintainers
47+
- Address feedback promptly and professionally
48+
- Be patient - reviews may take time
49+
50+
## Content Guidelines
51+
52+
### What We Accept
53+
- ✅ Constructive feedback and suggestions
54+
- ✅ Well-researched feature requests
55+
- ✅ Clear bug reports with reproduction steps
56+
- ✅ Professional, respectful communication
57+
- ✅ Documentation improvements
58+
- ✅ Specialized domain expertise
59+
60+
### What We Don't Accept
61+
- ❌ Hate speech, discrimination, or harassment
62+
- ❌ Spam, promotional content, or off-topic posts
63+
- ❌ Personal attacks or inflammatory language
64+
- ❌ Duplicate or low-effort submissions
65+
- ❌ Requests for malicious or harmful capabilities
66+
- ❌ Copyright infringement
67+
68+
## Quality Standards
69+
70+
### For Subagents
71+
- Clear, specific domain expertise
72+
- Well-structured prompt engineering
73+
- Practical use cases and examples
74+
- Appropriate safety considerations
75+
- Integration with existing patterns
76+
77+
### For Documentation
78+
- Clear, concise writing
79+
- Accurate technical information
80+
- Consistent formatting and style
81+
- Practical examples
82+
83+
## Community Guidelines
84+
85+
### Communication
86+
- **Be respectful** - Treat all community members with dignity
87+
- **Be constructive** - Focus on improving the project
88+
- **Be patient** - Allow time for responses and reviews
89+
- **Be helpful** - Share knowledge and assist others
90+
91+
### Collaboration
92+
- **Give credit** - Acknowledge others' contributions
93+
- **Share knowledge** - Help others learn and grow
94+
- **Stay focused** - Keep discussions on topic
95+
- **Follow up** - Respond to feedback and requests
96+
97+
## Getting Help
98+
99+
- 📖 **Documentation**: Check existing README files and agent descriptions
100+
- 💬 **Discussions**: Use GitHub Discussions for questions and brainstorming
101+
- 🐛 **Issues**: Report bugs or request features through issue templates
102+
- 📧 **Direct Contact**: Reach out to maintainers for sensitive matters
103+
104+
## Recognition
105+
106+
Contributors who consistently provide high-quality submissions and maintain professional conduct will be:
107+
- Acknowledged in release notes
108+
- Given priority review for future contributions
109+
- Potentially invited to become maintainers
110+
111+
## Enforcement
112+
113+
Violations of these guidelines may result in:
114+
1. **Warning** - First offense or minor issues
115+
2. **Temporary restrictions** - Suspension of contribution privileges
116+
3. **Permanent ban** - Severe or repeated violations
117+
118+
Reports of violations should be made through:
119+
- GitHub's built-in reporting tools
120+
- Issues tagged with `moderation`
121+
- Direct contact with maintainers
122+
123+
---
124+
125+
Thank you for helping make this project a welcoming, productive environment for everyone!

.claude/agents/.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: wshobson
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
name: Bug Report
3+
description: Report a bug or issue with an existing subagent
4+
title: "[BUG] "
5+
labels: ["bug"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for reporting a bug! Please fill out this template
11+
to help us understand and resolve the issue.
12+
13+
**Important**: This template is for technical bugs only.
14+
For questions, discussions, or general feedback, please use
15+
GitHub Discussions instead.
16+
17+
- type: checkboxes
18+
id: preliminary-checks
19+
attributes:
20+
label: Preliminary Checks
21+
description: Please confirm you have completed these steps
22+
options:
23+
- label: I have read the [Code of Conduct](.github/CODE_OF_CONDUCT.md)
24+
required: true
25+
- label: >-
26+
I have searched existing issues to ensure this is not a duplicate
27+
required: true
28+
- label: This report contains only technical information about a bug
29+
30+
- type: input
31+
id: subagent
32+
attributes:
33+
label: Affected Subagent
34+
description: Which subagent is experiencing the issue?
35+
placeholder: e.g., python-pro, frontend-developer, etc.
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: bug-description
41+
attributes:
42+
label: Bug Description
43+
description: A clear and concise description of what the bug is
44+
placeholder: Describe the unexpected behavior...
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: reproduction-steps
50+
attributes:
51+
label: Steps to Reproduce
52+
description: Steps to reproduce the behavior
53+
placeholder: |
54+
1. Use subagent for...
55+
2. Provide input...
56+
3. Observe output...
57+
4. See error...
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: expected-behavior
63+
attributes:
64+
label: Expected Behavior
65+
description: What you expected to happen
66+
placeholder: The subagent should have...
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: additional-context
72+
attributes:
73+
label: Additional Context
74+
description: Any other context, screenshots, or examples
75+
placeholder: Add any other context about the problem here...
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: GitHub Discussions
5+
url: https://github.com/wshobson/agents/discussions
6+
about: For questions, brainstorming, and general discussions about subagents
7+
- name: Community Guidelines
8+
url: https://github.com/wshobson/agents/blob/main/.github/CODE_OF_CONDUCT.md
9+
about: Read our Code of Conduct and community standards
10+
- name: Contributing Guide
11+
url: https://github.com/wshobson/agents/blob/main/.github/CONTRIBUTING.md
12+
about: Learn how to contribute effectively to this project
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
name: Feature Request
3+
description: Suggest an improvement or new feature for existing subagents
4+
title: "[FEATURE] "
5+
labels: ["enhancement"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for suggesting a feature! Please provide detailed
11+
information to help us understand your request.
12+
13+
**Note**: For new subagent proposals, please use the
14+
"New Subagent Proposal" template instead.
15+
16+
- type: checkboxes
17+
id: preliminary-checks
18+
attributes:
19+
label: Preliminary Checks
20+
description: Please confirm you have completed these steps
21+
options:
22+
- label: I have read the [Code of Conduct](.github/CODE_OF_CONDUCT.md)
23+
required: true
24+
- label: >-
25+
I have searched existing issues to ensure this is not a duplicate
26+
required: true
27+
- label: This is a constructive feature request for legitimate use cases
28+
required: true
29+
30+
- type: input
31+
id: subagent
32+
attributes:
33+
label: Target Subagent
34+
description: Which subagent would this feature enhance?
35+
placeholder: e.g., python-pro, frontend-developer, etc.
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: problem-description
41+
attributes:
42+
label: Problem Description
43+
description: What problem does this feature solve?
44+
placeholder: Currently, users need to... This is frustrating because...
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: proposed-solution
50+
attributes:
51+
label: Proposed Solution
52+
description: Describe your preferred solution
53+
placeholder: I would like the subagent to be able to...
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: use-cases
59+
attributes:
60+
label: Use Cases
61+
description: Provide specific examples of how this would be used
62+
placeholder: |
63+
1. When developing...
64+
2. For projects that...
65+
3. To help with...
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: alternatives
71+
attributes:
72+
label: Alternatives Considered
73+
description: Other solutions you've considered
74+
placeholder: I also considered... but this wouldn't work because...
75+
76+
- type: textarea
77+
id: additional-context
78+
attributes:
79+
label: Additional Context
80+
description: Any other relevant information
81+
placeholder: Add any other context, examples, or screenshots here...

0 commit comments

Comments
 (0)