48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
# L. 贡献指南
|
|
|
|
:::tip 概述
|
|
欢迎贡献代码、报告问题与完善文档。本页给出参与方式与质量要求。
|
|
:::
|
|
|
|
## 参与方式
|
|
|
|
| 方式 | 说明 |
|
|
|---|---|
|
|
| 报告问题 | 提 Issue：环境、复现步骤、期望/实际行为、日志（脱敏） |
|
|
| 提交修复 | Fork → 分支 → PR，关联 Issue 编号 |
|
|
| 功能建议 | Issue 讨论先行，大改动先对齐方案再动手 |
|
|
| 文档完善 | 文档站与代码同仓，PR 同样适用本指南 |
|
|
|
|
## 代码要求
|
|
|
|
- 遵守 [第 12 章 规范标准](/zh/standards/api-response.html)：数据访问铁律、模块规约、信封与分页契约
|
|
- 提交信息符合 [12.5 Git 提交规范](/zh/standards/git.html)
|
|
- PR 前本地通过：
|
|
|
|
```bash
|
|
make check # 后端：fmt + vet + test-short + check-config
|
|
cd ui && pnpm type:check && pnpm lint:eslint # 前端
|
|
```
|
|
|
|
- 新功能附测试或说明不测原因；修 bug 附复现描述
|
|
- 生成器模板改动与产物同提交
|
|
|
|
## PR 审查关注点
|
|
|
|
见 [12.7 代码审查清单](/zh/standards/code-review.html)。阻塞项：数据访问红线、契约稳定性、错误处理、权限与敏感信息、配置一致性。
|
|
|
|
## 文档贡献
|
|
|
|
- 页标题编号与侧边栏一致；跨章链接用绝对路径 + `.html`
|
|
- 代码示例首行注释标注源文件路径
|
|
- 示例代码须与当前代码行为一致（过期示例比没有更糟）
|
|
|
|
## 行为准则
|
|
|
|
对事不对人；技术分歧以可验证的事实收敛；帮助新手理解而非劝退。
|
|
|
|
## 相关
|
|
|
|
- [12.7 代码审查清单](/zh/standards/code-review.html)
|
|
- [11.11 CI/CD 与质量门禁](/zh/deploy/ci-cd.html)
|