mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 13:43:26 +08:00
fix: address review feedback from PR #929
- Add missing code-review.md and development-workflow.md to zh/README.md directory listing - Add mkdir -p command before copy in manual install instructions - Fix TypeScript test command path in SKILL-DEVELOPMENT-GUIDE.md - Add Anti-Patterns section to SKILL.md template - Add Template category to Skill Categories table in CONTRIBUTING.md - Add Pre-Review Requirements section to code-review.md (both en and zh) - Add Pre-Review Checks step to development-workflow.md (both en and zh) - Add trailing newlines to all files that were missing them
This commit is contained in:
@@ -142,6 +142,7 @@ Link to complementary skills (e.g., `related-skill-1`, `related-skill-2`).
|
|||||||
| **Workflow** | Step-by-step processes | `tdd-workflow`, `refactoring-workflow` |
|
| **Workflow** | Step-by-step processes | `tdd-workflow`, `refactoring-workflow` |
|
||||||
| **Domain Knowledge** | Specialized domains | `security-review`, `api-design` |
|
| **Domain Knowledge** | Specialized domains | `security-review`, `api-design` |
|
||||||
| **Tool Integration** | Tool/library usage | `docker-patterns`, `supabase-patterns` |
|
| **Tool Integration** | Tool/library usage | `docker-patterns`, `supabase-patterns` |
|
||||||
|
| **Template** | Project-specific skill templates | `project-guidelines-example` |
|
||||||
|
|
||||||
### Skill Checklist
|
### Skill Checklist
|
||||||
|
|
||||||
|
|||||||
@@ -90,6 +90,10 @@ Main patterns and guidelines.
|
|||||||
// Practical, tested examples
|
// Practical, tested examples
|
||||||
\`\`\`
|
\`\`\`
|
||||||
|
|
||||||
|
## Anti-Patterns
|
||||||
|
|
||||||
|
Show what NOT to do with concrete examples.
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
- Actionable guidelines
|
- Actionable guidelines
|
||||||
@@ -602,14 +606,14 @@ description: Quick reference for [API/Library].
|
|||||||
Test all code examples:
|
Test all code examples:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# For TypeScript
|
# For TypeScript (run from inside the skill directory or specify the path)
|
||||||
npx tsc --noEmit examples/*.ts
|
npx tsc --noEmit skills/your-skill-name/examples/*.ts
|
||||||
|
|
||||||
# For Python
|
# For Python
|
||||||
python -m py_compile examples/*.py
|
python -m py_compile skills/your-skill-name/examples/*.py
|
||||||
|
|
||||||
# For Go
|
# For Go
|
||||||
go build ./examples/...
|
go build ./skills/your-skill-name/examples/...
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -14,6 +14,14 @@ Code review ensures quality, security, and maintainability before code is merged
|
|||||||
- When architectural changes are made
|
- When architectural changes are made
|
||||||
- Before merging pull requests
|
- Before merging pull requests
|
||||||
|
|
||||||
|
**Pre-Review Requirements:**
|
||||||
|
|
||||||
|
Before requesting review, ensure:
|
||||||
|
|
||||||
|
- All automated checks (CI/CD) are passing
|
||||||
|
- Merge conflicts are resolved
|
||||||
|
- Branch is up to date with target branch
|
||||||
|
|
||||||
## Review Checklist
|
## Review Checklist
|
||||||
|
|
||||||
Before marking code complete:
|
Before marking code complete:
|
||||||
|
|||||||
@@ -36,3 +36,9 @@ The Feature Implementation Workflow describes the development pipeline: research
|
|||||||
- Detailed commit messages
|
- Detailed commit messages
|
||||||
- Follow conventional commits format
|
- Follow conventional commits format
|
||||||
- See [git-workflow.md](./git-workflow.md) for commit message format and PR process
|
- See [git-workflow.md](./git-workflow.md) for commit message format and PR process
|
||||||
|
|
||||||
|
5. **Pre-Review Checks**
|
||||||
|
- Verify all automated checks (CI/CD) are passing
|
||||||
|
- Resolve any merge conflicts
|
||||||
|
- Ensure branch is up to date with target branch
|
||||||
|
- Only request review after these checks pass
|
||||||
|
|||||||
@@ -14,7 +14,9 @@ rules/
|
|||||||
│ ├── patterns.md
|
│ ├── patterns.md
|
||||||
│ ├── hooks.md
|
│ ├── hooks.md
|
||||||
│ ├── agents.md
|
│ ├── agents.md
|
||||||
│ └── security.md
|
│ ├── security.md
|
||||||
|
│ ├── code-review.md
|
||||||
|
│ └── development-workflow.md
|
||||||
├── zh/ # 中文翻译版本
|
├── zh/ # 中文翻译版本
|
||||||
│ ├── coding-style.md
|
│ ├── coding-style.md
|
||||||
│ ├── git-workflow.md
|
│ ├── git-workflow.md
|
||||||
@@ -24,6 +26,7 @@ rules/
|
|||||||
│ ├── hooks.md
|
│ ├── hooks.md
|
||||||
│ ├── agents.md
|
│ ├── agents.md
|
||||||
│ ├── security.md
|
│ ├── security.md
|
||||||
|
│ ├── code-review.md
|
||||||
│ └── development-workflow.md
|
│ └── development-workflow.md
|
||||||
├── typescript/ # TypeScript/JavaScript 特定
|
├── typescript/ # TypeScript/JavaScript 特定
|
||||||
├── python/ # Python 特定
|
├── python/ # Python 特定
|
||||||
@@ -60,6 +63,9 @@ rules/
|
|||||||
> 并破坏语言特定文件使用的 `../common/` 相对引用。
|
> 并破坏语言特定文件使用的 `../common/` 相对引用。
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# 创建目标目录
|
||||||
|
mkdir -p ~/.claude/rules
|
||||||
|
|
||||||
# 安装通用规则(所有项目必需)
|
# 安装通用规则(所有项目必需)
|
||||||
cp -r rules/common ~/.claude/rules/common
|
cp -r rules/common ~/.claude/rules/common
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,14 @@
|
|||||||
- 进行架构更改时
|
- 进行架构更改时
|
||||||
- 合并 pull request 之前
|
- 合并 pull request 之前
|
||||||
|
|
||||||
|
**审查前要求:**
|
||||||
|
|
||||||
|
在请求审查之前,确保:
|
||||||
|
|
||||||
|
- 所有自动化检查(CI/CD)已通过
|
||||||
|
- 合并冲突已解决
|
||||||
|
- 分支已与目标分支同步
|
||||||
|
|
||||||
## 审查检查清单
|
## 审查检查清单
|
||||||
|
|
||||||
在标记代码完成之前:
|
在标记代码完成之前:
|
||||||
|
|||||||
@@ -36,3 +36,9 @@
|
|||||||
- 详细的提交消息
|
- 详细的提交消息
|
||||||
- 遵循约定式提交格式
|
- 遵循约定式提交格式
|
||||||
- 参见 [git-workflow.md](./git-workflow.md) 了解提交消息格式和 PR 流程
|
- 参见 [git-workflow.md](./git-workflow.md) 了解提交消息格式和 PR 流程
|
||||||
|
|
||||||
|
5. **审查前检查**
|
||||||
|
- 验证所有自动化检查(CI/CD)已通过
|
||||||
|
- 解决任何合并冲突
|
||||||
|
- 确保分支已与目标分支同步
|
||||||
|
- 仅在这些检查通过后请求审查
|
||||||
|
|||||||
Reference in New Issue
Block a user