diff --git a/.gitee/CONTRIBUTING.md b/.gitee/CONTRIBUTING.md new file mode 100644 index 00000000..6a9a1b2e --- /dev/null +++ b/.gitee/CONTRIBUTING.md @@ -0,0 +1,68 @@ +# 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 + - 检查内容：提交信息格式、类型、描述等 + +### 提交信息格式要求 + +提交信息应遵循以下格式： + +``` +(): + + + +