mirror of
https://gitee.com/ShopeX/OMS
synced 2026-03-22 10:25:35 +08:00
69 lines
2.1 KiB
Markdown
69 lines
2.1 KiB
Markdown
# Contributing to ONEX OMS
|
||
|
||
感谢你对 ONEX OMS 的贡献意愿！请遵循以下简要流程：
|
||
|
||
## 快速流程
|
||
1. Fork 仓库并创建特性分支：`git checkout -b feature/your-change`
|
||
2. 安装依赖：`composer install --no-dev`
|
||
3. 开发与自测：推荐运行相关单测（如有）与基础功能验证
|
||
4. 提交：遵循 Conventional Commits，例如 `feat: add xxx`
|
||
5. 提交 PR：描述改动、测试范围、风险点
|
||
|
||
## 规范要点
|
||
- 提交信息：使用 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
|
||
- 代码风格：参考 [编码规范（在线版）](https://op.shopex.cn/doc_oms_dev/100.rule/1.code.html)
|
||
- 配置与安装：参考 [部署指南（在线版）](https://op.shopex.cn/doc_oms_dev/200.install-deploy/deployment-guide.html)
|
||
|
||
## 问题反馈
|
||
- Bug / 需求：创建 Issue，并附上复现场景、期望行为、环境信息
|
||
- 安全问题：请勿公开提 Issue，可通过私下渠道联系维护者
|
||
|
||
## Gitee Go CI/CD
|
||
|
||
本项目使用 Gitee Go 进行持续集成，配置文件位于 `.gitee/workflows/` 目录。
|
||
|
||
### 自动检查
|
||
|
||
提交代码时，Gitee Go 会自动运行以下检查：
|
||
|
||
- **提交信息格式检查** (`commitlint.yml`)：检查提交信息是否符合 Conventional Commits 规范
|
||
- 触发时机：推送到 `master` 分支或创建/更新 Pull Request
|
||
- 检查内容：提交信息格式、类型、描述等
|
||
|
||
### 提交信息格式要求
|
||
|
||
提交信息应遵循以下格式：
|
||
|
||
```
|
||
<type>(<scope>): <subject>
|
||
|
||
<body>
|
||
|
||
<footer>
|
||
```
|
||
|
||
**类型 (type)**：
|
||
- `feat`: 新功能
|
||
- `fix`: 修复 bug
|
||
- `docs`: 文档更新
|
||
- `style`: 代码格式调整（不影响功能）
|
||
- `refactor`: 代码重构
|
||
- `test`: 测试相关
|
||
- `chore`: 构建/工具链相关
|
||
|
||
**示例**：
|
||
```
|
||
feat: 添加用户登录功能
|
||
fix(api): 修复订单查询接口的 bug
|
||
docs: 更新 README 文档
|
||
```
|
||
|
||
### 注意事项
|
||
|
||
- 确保提交信息符合规范，否则 CI 检查会失败
|
||
- 如果 CI 检查失败，请查看 Gitee Go 的日志输出
|
||
- 更多关于 Gitee Go 的使用说明，请参考 [Gitee Go 官方文档](https://gitee.com/help/articles/4292)
|
||
|
||
感谢你的贡献！
|
||
|