mirror of
https://github.com/kiddin9/op-packages.git
synced 2026-11-13 20:08:05 +08:00
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# 贡献指南
|
||
|
||
> 项目：luci-app-liteportal
|
||
|
||
## 分支策略
|
||
|
||
- `main` 为保护分支，不要直接推送。
|
||
- 从 `main` 切 `feature/<名称>` 分支，一个功能一个分支。
|
||
|
||
## 提交规范
|
||
|
||
- Conventional Commits，type 用英文前缀：
|
||
`feat:`（新功能）`fix:`（修复）`docs:`（文档）`test:`（测试）`chore:`（杂项）`refactor:`（重构）`ci:`（CI）。
|
||
- 描述可用中文，简明；标题总长 ≤ 72 字符。
|
||
- **一个提交只改一件事。**
|
||
|
||
## Pull Request
|
||
|
||
- 向 `main` 提 PR，说明做了什么、为什么，并关联 `ROADMAP.md` 对应行。
|
||
- 描述精简但准确，不反复论证。
|
||
- 确保本地检查通过后再提。
|
||
|
||
## 本地检查
|
||
|
||
```sh
|
||
sh scripts/check.sh
|
||
```
|
||
|
||
这就是 CI 跑的全部检查（JS 语法、JSON、shellcheck、msgfmt、ubus↔ACL、
|
||
menu.d 视图 path ↔ 视图文件、运行时标识一致性、行尾、占位符），
|
||
退出码非零即失败。**加检查请改 `scripts/check.sh`，不要在 CI workflow 里另加** ——
|
||
否则本地与 CI 会漂移。
|
||
|
||
## 红线与完成定义
|
||
|
||
- 提交前请阅读 [AGENTS.md](AGENTS.md) 的「红线」。
|
||
- 功能是否算完成，以 [docs/definition-of-done.md](docs/definition-of-done.md) 为准。
|
||
- 「改了什么就要同改什么」见 [AGENTS.md](AGENTS.md) §9「同改矩阵」（该表已统一到 AGENTS.md，此处不再重复）。
|
||
|
||
## 许可证
|
||
|
||
本项目采用 GPL-2.0-only 许可证，详见 [LICENSE](LICENSE)。
|