Skip to content

Commit e19eb13

Browse files
authored
Merge pull request #49 from LiTeXz/codex/user-facing-readme-gpl
Make the README user-facing and adopt GPLv3
2 parents 5eee917 + 1de5c9d commit e19eb13

4 files changed

Lines changed: 351 additions & 181 deletions

File tree

.codex-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
},
1111
"homepage": "https://github.com/LiTeXz/devflow-skills",
1212
"repository": "https://github.com/LiTeXz/devflow-skills",
13-
"license": "MIT",
13+
"license": "GPL-3.0-only",
1414
"keywords": ["codex", "skills", "workflow", "ddd", "tdd"],
1515
"skills": "./skills/",
1616
"hooks": "./hooks/hooks.codex.json",

CONTRIBUTING.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# 参与贡献
2+
3+
感谢你参与 DevOpsFlow。提交改动前,请先阅读本说明。
4+
5+
## 环境要求
6+
7+
- [Bun](https://bun.sh/)
8+
- [pnpm](https://pnpm.io/)
9+
- TypeScript
10+
11+
安装依赖:
12+
13+
```bash
14+
pnpm install
15+
```
16+
17+
## 开始开发
18+
19+
1. 从最新的目标分支创建功能分支。
20+
2. 保持改动范围单一,不混入无关调整。
21+
3. 修改 skill 时,同步检查其 `SKILL.md``agents/``references/``scripts/``templates/`
22+
4. 新增或改变行为时,补充对应测试。
23+
5. 提交前完成相关验证。
24+
25+
请勿直接在 `main``dev``develop``devlop` 等集成分支上开发。
26+
27+
## 项目结构
28+
29+
```text
30+
.codex-plugin/ Codex 插件清单
31+
.opencode/ OpenCode 适配
32+
agents/ Agent 配置
33+
assets/ 图片与插件资源
34+
hooks/ Codex hooks
35+
scripts/ 校验脚本与测试
36+
skills/ DevOpsFlow skills
37+
src/shared/ 共享实现
38+
```
39+
40+
## 验证
41+
42+
```bash
43+
pnpm test
44+
pnpm typecheck
45+
pnpm lint
46+
```
47+
48+
也可以按改动范围运行专项验证:
49+
50+
```bash
51+
pnpm test:hooks
52+
pnpm test:validators
53+
pnpm check:skill-metadata
54+
```
55+
56+
提交 PR 时,请说明已运行的命令及结果。未运行的检查也应注明原因。
57+
58+
## 提交信息
59+
60+
使用中文 Conventional Commits:
61+
62+
```text
63+
feat: 新增工程工作流入口调度器
64+
fix: 修复 DDD 校验脚本编码问题
65+
docs: 更新技能组合说明
66+
test: 补充 TDD 协议回归用例
67+
chore: 调整 skill 元数据
68+
```
69+
70+
常用类型包括 `feat``fix``docs``test``refactor``chore`
71+
72+
## Pull Request
73+
74+
提交 PR 前,请确认:
75+
76+
- 改动目的和范围清晰
77+
- 没有包含无关文件
78+
- 新行为有相应测试或验证证据
79+
- 文档与插件元数据已按需同步
80+
- 所有必要检查已通过
81+
- PR 描述说明了风险、限制或未完成事项
82+
83+
建议每个 PR 只解决一个明确问题,以便审查和回退。
84+
85+
## 许可证
86+
87+
提交贡献即表示你同意贡献内容按照本项目的 [GNU General Public License v3.0](LICENSE) 发布。

0 commit comments

Comments
 (0)