Skip to content

Commit da74f85

Browse files
committed
fix: address review feedback from PR anomalyco#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
1 parent c146fae commit da74f85

15 files changed

Lines changed: 57 additions & 18 deletions

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ Link to complementary skills (e.g., `related-skill-1`, `related-skill-2`).
142142
| **Workflow** | Step-by-step processes | `tdd-workflow`, `refactoring-workflow` |
143143
| **Domain Knowledge** | Specialized domains | `security-review`, `api-design` |
144144
| **Tool Integration** | Tool/library usage | `docker-patterns`, `supabase-patterns` |
145+
| **Template** | Project-specific skill templates | `project-guidelines-example` |
145146

146147
### Skill Checklist
147148

‎docs/SKILL-DEVELOPMENT-GUIDE.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@ Main patterns and guidelines.
9090
// Practical, tested examples
9191
\`\`\`
9292

93+
## Anti-Patterns
94+
95+
Show what NOT to do with concrete examples.
96+
9397
## Best Practices
9498

9599
- Actionable guidelines
@@ -602,14 +606,14 @@ description: Quick reference for [API/Library].
602606
Test all code examples:
603607

604608
```bash
605-
# For TypeScript
606-
npx tsc --noEmit examples/*.ts
609+
# For TypeScript (run from inside the skill directory or specify the path)
610+
npx tsc --noEmit skills/your-skill-name/examples/*.ts
607611

608612
# For Python
609-
python -m py_compile examples/*.py
613+
python -m py_compile skills/your-skill-name/examples/*.py
610614

611615
# For Go
612-
go build ./examples/...
616+
go build ./skills/your-skill-name/examples/...
613617
```
614618

615619
---
@@ -903,4 +907,4 @@ npm run test:e2e
903907

904908
---
905909

906-
**Remember**: A good skill is focused, actionable, and immediately useful. Write skills you'd want to use yourself.
910+
**Remember**: A good skill is focused, actionable, and immediately useful. Write skills you'd want to use yourself.

‎rules/common/code-review.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ Code review ensures quality, security, and maintainability before code is merged
1414
- When architectural changes are made
1515
- Before merging pull requests
1616

17+
**Pre-Review Requirements:**
18+
19+
Before requesting review, ensure:
20+
21+
- All automated checks (CI/CD) are passing
22+
- Merge conflicts are resolved
23+
- Branch is up to date with target branch
24+
1725
## Review Checklist
1826

1927
Before marking code complete:
@@ -113,4 +121,4 @@ This rule works with:
113121
- [testing.md](testing.md) - Test coverage requirements
114122
- [security.md](security.md) - Security checklist
115123
- [git-workflow.md](git-workflow.md) - Commit standards
116-
- [agents.md](agents.md) - Agent delegation
124+
- [agents.md](agents.md) - Agent delegation

‎rules/common/development-workflow.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,9 @@ The Feature Implementation Workflow describes the development pipeline: research
3636
- Detailed commit messages
3737
- Follow conventional commits format
3838
- See [git-workflow.md](./git-workflow.md) for commit message format and PR process
39+
40+
5. **Pre-Review Checks**
41+
- Verify all automated checks (CI/CD) are passing
42+
- Resolve any merge conflicts
43+
- Ensure branch is up to date with target branch
44+
- Only request review after these checks pass

‎rules/zh/README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ rules/
1414
│ ├── patterns.md
1515
│ ├── hooks.md
1616
│ ├── agents.md
17-
│ └── security.md
17+
│ ├── security.md
18+
│ ├── code-review.md
19+
│ └── development-workflow.md
1820
├── zh/ # 中文翻译版本
1921
│ ├── coding-style.md
2022
│ ├── git-workflow.md
@@ -24,6 +26,7 @@ rules/
2426
│ ├── hooks.md
2527
│ ├── agents.md
2628
│ ├── security.md
29+
│ ├── code-review.md
2730
│ └── development-workflow.md
2831
├── typescript/ # TypeScript/JavaScript 特定
2932
├── python/ # Python 特定
@@ -60,6 +63,9 @@ rules/
6063
> 并破坏语言特定文件使用的 `../common/` 相对引用。
6164
6265
```bash
66+
# 创建目标目录
67+
mkdir -p ~/.claude/rules
68+
6369
# 安装通用规则(所有项目必需)
6470
cp -r rules/common ~/.claude/rules/common
6571

@@ -99,4 +105,4 @@ cp -r rules/php ~/.claude/rules/php
99105

100106
`rules/common/` 中可能被语言特定文件覆盖的规则会标记:
101107

102-
> **语言说明**:此规则可能被语言特定规则覆盖,对于某些语言,该模式可能不是惯用的。
108+
> **语言说明**:此规则可能被语言特定规则覆盖,对于某些语言,该模式可能不是惯用的。

‎rules/zh/agents.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@
4747
- 高级工程师
4848
- 安全专家
4949
- 一致性审查者
50-
- 冗余检查者
50+
- 冗余检查者

‎rules/zh/code-review.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414
- 进行架构更改时
1515
- 合并 pull request 之前
1616

17+
**审查前要求:**
18+
19+
在请求审查之前,确保:
20+
21+
- 所有自动化检查(CI/CD)已通过
22+
- 合并冲突已解决
23+
- 分支已与目标分支同步
24+
1725
## 审查检查清单
1826

1927
在标记代码完成之前:
@@ -113,4 +121,4 @@
113121
- [testing.md](testing.md) - 测试覆盖率要求
114122
- [security.md](security.md) - 安全检查清单
115123
- [git-workflow.md](git-workflow.md) - 提交标准
116-
- [agents.md](agents.md) - 代理委托
124+
- [agents.md](agents.md) - 代理委托

‎rules/zh/coding-style.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@
4545
- [ ] 没有深层嵌套(>4 层)
4646
- [ ] 正确的错误处理
4747
- [ ] 没有硬编码值(使用常量或配置)
48-
- [ ] 没有变更(使用不可变模式)
48+
- [ ] 没有变更(使用不可变模式)

‎rules/zh/development-workflow.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,10 @@
3535
4. **提交与推送**
3636
- 详细的提交消息
3737
- 遵循约定式提交格式
38-
- 参见 [git-workflow.md](./git-workflow.md) 了解提交消息格式和 PR 流程
38+
- 参见 [git-workflow.md](./git-workflow.md) 了解提交消息格式和 PR 流程
39+
40+
5. **审查前检查**
41+
- 验证所有自动化检查(CI/CD)已通过
42+
- 解决任何合并冲突
43+
- 确保分支已与目标分支同步
44+
- 仅在这些检查通过后请求审查

‎rules/zh/git-workflow.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@
2121
5. 如果是新分支,使用 `-u` 标志推送
2222

2323
> 对于 git 操作之前的完整开发流程(规划、TDD、代码审查),
24-
> 参见 [development-workflow.md](./development-workflow.md)。
24+
> 参见 [development-workflow.md](./development-workflow.md)。

0 commit comments

Comments
 (0)