Skip to content

Commit c649398

Browse files
author
SonicBotMan
committed
feat: 初始化 GitHub Development Standard Skill
【核心特性】 1. 完整的 9 步开发流程 - Step 1: 读 issue（只理解，不改代码） - Step 2: 写5行任务卡 - Step 3: 确定基线版本 - Step 4: 列改动点 - Step 5: 编码（最小修改） - Step 6: 本地验证（4层测试） - Step 7: 看 diff（确认没偏题） - Step 8: 写发布说明 - Step 9: 最后复盘 2. 4 层验证体系 - Layer 1: 语法验证（py_compile） - Layer 2: 导入验证 - Layer 3: 行为验证（最小样例） - Layer 4: 回归验证 3. 15 项验收清单 - A. 需求一致性（3项） - B. 技术正确性（4项） - C. 测试验证（4项） - D. 发布质量（4项） 4. 8 条编码纪律 - 黄金法则：一次提交只解决一个问题集合 - 详细的编码规范 【完整文档】 - ✅ SKILL.md - 核心定义 - ✅ README.md - 项目介绍 - ✅ CONTRIBUTING.md - 贡献指南 - ✅ CHANGELOG.md - 版本历史 - ✅ docs/ - 详细文档 - ✅ examples/ - 实战示例 - ✅ templates/ - 模板文件 【来源】 - LobsterPress Issue #88 - 工程流程建议 - 学习时间: 2026-03-13
0 parents  commit c649398

10 files changed

Lines changed: 1938 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Python
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
*.so
6+
.Python
7+
build/
8+
develop-eggs/
9+
dist/
10+
downloads/
11+
eggs/
12+
.eggs/
13+
lib/
14+
lib64/
15+
parts/
16+
sdist/
17+
var/
18+
wheels/
19+
*.egg-info/
20+
.installed.cfg
21+
*.egg
22+
MANIFEST
23+
24+
# Virtual Environment
25+
venv/
26+
ENV/
27+
env/
28+
.venv
29+
30+
# IDE
31+
.vscode/
32+
.idea/
33+
*.swp
34+
*.swo
35+
*~
36+
.DS_Store
37+
38+
# Testing
39+
.pytest_cache/
40+
.coverage
41+
htmlcov/
42+
.tox/
43+
.hypothesis/
44+
45+
# Documentation
46+
docs/_build/
47+
site/
48+
49+
# Logs
50+
*.log
51+
52+
# Temporary files
53+
*.tmp
54+
*.bak
55+
.cache/
56+
57+
# Distribution
58+
*.tar.gz
59+
*.zip

‎CHANGELOG.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
---
9+
10+
## [Unreleased]
11+
12+
### Added
13+
- 未来功能规划
14+
15+
---
16+
17+
## [1.0.0] - 2026-03-13
18+
19+
### Added
20+
21+
#### 🎯 核心特性
22+
23+
- ✅ **完整的 9 步开发流程**
24+
- Step 1: 读 issue（只理解，不改代码）
25+
- Step 2: 写"5行任务卡"（目标、边界、影响范围、非目标）
26+
- Step 3: 确定基线版本（从哪个 tag/文件开始改）
27+
- Step 4: 列改动点（只列具体改动）
28+
- Step 5: 编码（最小修改）
29+
- Step 6: 本地验证（4层测试：语法、导入、行为、回归）
30+
- Step 7: 看 diff（确认没偏题、没改过头）
31+
- Step 8: 写发布说明（修复项、验证项、未变更项）
32+
- Step 9: 最后复盘
33+
34+
- ✅ **4 层验证体系**
35+
- Layer 1: 语法验证（`py_compile`）
36+
- Layer 2: 导入验证
37+
- Layer 3: 行为验证（最小样例）
38+
- Layer 4: 回归验证
39+
40+
- ✅ **15 项验收清单**
41+
- A. 需求一致性（3项）
42+
- B. 技术正确性（4项）
43+
- C. 测试验证（4项）
44+
- D. 发布质量（4项）
45+
46+
- ✅ **8 条编码纪律**
47+
1. 先复制旧代码，再局部替换，不要凭记忆重写
48+
2. 改函数前，先通读函数的输入、输出、副作用
49+
3. 涉及数据结构变化时，先搜所有使用点
50+
4. 不要同时改逻辑和风格
51+
5. 不要在 bug fix 里做重构
52+
6. 不要修改未被需求要求的行为
53+
7. 不要在没有验证前说"修好了"
54+
8. 不要让 release note 超前于实际代码
55+
56+
#### 📝 完整模板
57+
58+
- ✅ **需求澄清模板**
59+
- 任务类型
60+
- 问题现象
61+
- 正确行为
62+
- 影响范围
63+
- 非目标
64+
65+
- ✅ **改动设计模板**
66+
- 目标文件
67+
- 目标函数
68+
- 需要修改
69+
- 不应修改
70+
- 风险点
71+
- 验证方式
72+
73+
- ✅ **Commit Message 模板**
74+
- ✅ **Release Note 模板**
75+
76+
#### 📚 文档
77+
78+
- ✅ SKILL.md - 完整的开发标准
79+
- ✅ README.md - 项目介绍
80+
- ✅ CONTRIBUTING.md - 贡献指南
81+
- ✅ CHANGELOG.md - 版本历史
82+
- ✅ docs/ - 详细文档
83+
- ✅ examples/ - 实战示例
84+
- ✅ templates/ - 模板文件
85+
86+
#### 🎓 能力训练
87+
88+
- ✅ 精准改动能力
89+
- ✅ 验证能力
90+
- ✅ 一致性能力
91+
- ✅ 收敛能力
92+
93+
### Changed
94+
95+
- N/A
96+
97+
### Deprecated
98+
99+
- N/A
100+
101+
### Removed
102+
103+
- N/A
104+
105+
### Fixed
106+
107+
- N/A
108+
109+
### Security
110+
111+
- N/A
112+
113+
---
114+
115+
## Version History
116+
117+
| Version | Date | Changes |
118+
|---------|------|---------|
119+
| 1.0.0 | 2026-03-13 | 初始版本发布 |
120+
121+
---
122+
123+
**Format**: [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
124+
**Versioning**: [Semantic Versioning](https://semver.org/spec/v2.0.0.html)

‎CONTRIBUTING.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# CONTRIBUTING.md
2+
3+
## 🤝 贡献指南
4+
5+
感谢你考虑为 GitHub Development Standard 做出贡献！
6+
7+
---
8+
9+
## 📋 如何贡献
10+
11+
### 1. 报告 Bug
12+
13+
如果你发现了 bug，请 [创建 Issue](https://github.com/SonicBotMan/github-development-standard/issues/new)
14+
包含：
15+
- Bug 描述
16+
- 处现步骤
17+
- 预期行为
18+
- 实际行为
19+
20+
### 2. 建议新功能
21+
22+
如果你有新功能建议
23+
请 [创建 Feature Request](https://github.com/SonicBotMan/github-development-standard/issues/new)
24+
包含：
25+
- 功能描述
26+
- 使用场景
27+
- 预期收益
28+
29+
### 3. 提交代码
30+
31+
1. **Fork 项目**
32+
2. **创建分支** (`git checkout -b feature/AmazingFeature`)
33+
3. **遵守本 Skill 的开发标准**（ irony! 😄）
34+
4. **提交更改** (`git commit -m 'Add some AmazingFeature'`)
35+
5. **推送到分支** (`git push origin feature/AmazingFeature`)
36+
6. **创建 Pull Request**
37+
38+
---
39+
40+
## ✅ 代码规范
41+
42+
### 遵守本 Skill 的标准
43+
44+
**是的，我们用这个 Skill 本身的标准来开发这个 Skill！**
45+
46+
- ✅ 先定义问题，再写代码
47+
- ✅ 最小修改原则
48+
- ✅ 4 层验证
49+
- ✅ Diff 审查
50+
- ✅ 验收清单
51+
52+
### 风格指南
53+
54+
- **Markdown**: 使用标准 Markdown 格式
55+
- **文档**: 中英文双语
56+
- **示例**: 提供可运行的示例
57+
- **注释**: 关键逻辑添加注释
58+
59+
---
60+
61+
## 🧪 测试
62+
63+
### 本 Skill 的测试
64+
65+
```bash
66+
# 验证 SKILL.md 格式
67+
python3 -c "import yaml; yaml.safe_load(open('SKILL.md'))"
68+
69+
# 验证文档完整性
70+
ls README.md docs/ examples/ templates/
71+
```
72+
73+
---
74+
75+
## 📖 文档规范
76+
77+
### 中英文同步
78+
79+
**必须遵守中英文文档同步更新规则：**
80+
81+
1. 修改 `README.md` 后，必须同步修改 `docs/README_EN.md`
82+
2. 修改 `SKILL.md` 后，确保英文版同步
83+
3. 新增示例时，提供中英文说明
84+
85+
---
86+
87+
## 🎯 开发流程
88+
89+
### 使用本 Skill 的标准流程
90+
91+
1. ✅ **读 issue** - 理解需求
92+
2. ✅ **写"5行任务卡"** - 明确目标
93+
3. ✅ **确定基线版本** - 从哪个版本开始
94+
4. ✅ **列改动点** - 明确改动范围
95+
5. ✅ **编码** - 最小修改
96+
6. ✅ **本地验证** - 4 层测试
97+
7. ✅ **看 diff** - 确认没偏题
98+
8. ✅ **写发布说明** - 文档同步
99+
9. ✅ **最后复盘** - 总结经验
100+
101+
---
102+
103+
## 📞 联系方式
104+
105+
- **GitHub Issues**: https://github.com/SonicBotMan/github-development-standard/issues
106+
- **Discord**: [OpenClaw Community](https://discord.gg/clawd)
107+
108+
---
109+
110+
**感谢你的贡献！** 💕

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 SonicBotMan Team
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)