mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-02-18 20:23:08 +08:00
88054de673
* docs: add Chinese versions docs * update --------- Co-authored-by: neo <neo.dowithless@gmail.com>
200 lines
3.2 KiB
Markdown
200 lines
3.2 KiB
Markdown
# 为 Everything Claude Code 做贡献
|
||
|
||
感谢您希望做出贡献。这个仓库旨在成为 Claude Code 用户的社区资源。
|
||
|
||
## 我们寻找什么
|
||
|
||
### 智能体
|
||
|
||
能够很好地处理特定任务的新智能体：
|
||
|
||
* 语言特定的审查员（Python、Go、Rust）
|
||
* 框架专家（Django、Rails、Laravel、Spring）
|
||
* DevOps 专家（Kubernetes、Terraform、CI/CD）
|
||
* 领域专家（ML 流水线、数据工程、移动端）
|
||
|
||
### 技能
|
||
|
||
工作流定义和领域知识：
|
||
|
||
* 语言最佳实践
|
||
* 框架模式
|
||
* 测试策略
|
||
* 架构指南
|
||
* 领域特定知识
|
||
|
||
### 命令
|
||
|
||
调用有用工作流的斜杠命令：
|
||
|
||
* 部署命令
|
||
* 测试命令
|
||
* 文档命令
|
||
* 代码生成命令
|
||
|
||
### 钩子
|
||
|
||
有用的自动化：
|
||
|
||
* 代码检查/格式化钩子
|
||
* 安全检查
|
||
* 验证钩子
|
||
* 通知钩子
|
||
|
||
### 规则
|
||
|
||
始终遵循的指导原则：
|
||
|
||
* 安全规则
|
||
* 代码风格规则
|
||
* 测试要求
|
||
* 命名约定
|
||
|
||
### MCP 配置
|
||
|
||
新的或改进的 MCP 服务器配置：
|
||
|
||
* 数据库集成
|
||
* 云提供商 MCP
|
||
* 监控工具
|
||
* 通讯工具
|
||
|
||
***
|
||
|
||
## 如何贡献
|
||
|
||
### 1. Fork 仓库
|
||
|
||
```bash
|
||
git clone https://github.com/YOUR_USERNAME/everything-claude-code.git
|
||
cd everything-claude-code
|
||
```
|
||
|
||
### 2. 创建一个分支
|
||
|
||
```bash
|
||
git checkout -b add-python-reviewer
|
||
```
|
||
|
||
### 3. 添加您的贡献
|
||
|
||
将文件放在适当的目录中：
|
||
|
||
* `agents/` 用于新的智能体
|
||
* `skills/` 用于技能（可以是单个 .md 文件或目录）
|
||
* `commands/` 用于斜杠命令
|
||
* `rules/` 用于规则文件
|
||
* `hooks/` 用于钩子配置
|
||
* `mcp-configs/` 用于 MCP 服务器配置
|
||
|
||
### 4. 遵循格式
|
||
|
||
**智能体** 应包含 frontmatter：
|
||
|
||
```markdown
|
||
---
|
||
name: agent-name
|
||
description: What it does
|
||
tools: Read, Grep, Glob, Bash
|
||
model: sonnet
|
||
---
|
||
|
||
Instructions here...
|
||
```
|
||
|
||
**技能** 应清晰且可操作：
|
||
|
||
```markdown
|
||
# Skill Name
|
||
|
||
## When to Use
|
||
|
||
...
|
||
|
||
## How It Works
|
||
|
||
...
|
||
|
||
## Examples
|
||
|
||
...
|
||
```
|
||
|
||
**命令** 应解释其功能：
|
||
|
||
```markdown
|
||
---
|
||
description: Brief description of command
|
||
---
|
||
|
||
# Command Name
|
||
|
||
Detailed instructions...
|
||
```
|
||
|
||
**钩子** 应包含描述：
|
||
|
||
```json
|
||
{
|
||
"matcher": "...",
|
||
"hooks": [...],
|
||
"description": "What this hook does"
|
||
}
|
||
```
|
||
|
||
### 5. 测试您的贡献
|
||
|
||
在提交之前，请确保您的配置能在 Claude Code 中正常工作。
|
||
|
||
### 6. 提交 PR
|
||
|
||
```bash
|
||
git add .
|
||
git commit -m "Add Python code reviewer agent"
|
||
git push origin add-python-reviewer
|
||
```
|
||
|
||
然后提交一个 PR，包含以下内容：
|
||
|
||
* 您添加了什么
|
||
* 为什么它有用
|
||
* 您是如何测试的
|
||
|
||
***
|
||
|
||
## 指导原则
|
||
|
||
### 应该做的
|
||
|
||
* 保持配置专注且模块化
|
||
* 包含清晰的描述
|
||
* 提交前进行测试
|
||
* 遵循现有模式
|
||
* 记录任何依赖项
|
||
|
||
### 不应该做的
|
||
|
||
* 包含敏感数据（API 密钥、令牌、路径）
|
||
* 添加过于复杂或小众的配置
|
||
* 提交未经测试的配置
|
||
* 创建重复的功能
|
||
* 添加需要特定付费服务且没有替代方案的配置
|
||
|
||
***
|
||
|
||
## 文件命名
|
||
|
||
* 使用小写字母和连字符：`python-reviewer.md`
|
||
* 要有描述性：`tdd-workflow.md` 而不是 `workflow.md`
|
||
* 确保智能体/技能名称与文件名匹配
|
||
|
||
***
|
||
|
||
## 有问题吗？
|
||
|
||
请提出问题或在 X 上联系我们：[@affaanmustafa](https://x.com/affaanmustafa)
|
||
|
||
***
|
||
|
||
感谢您的贡献。让我们共同构建一个优秀的资源。
|