贡献指南
ContiNew(Continue New)系列项目致力于通过持续迭代,为开发者提供舒适的开发体验。作为开源社区,我们的初衷是希望通过开源协作模式,提升技术透明度、放大集体智慧、共创优秀实践,源源不断地为企业级项目开发提供助力。
我们诚挚邀请广大社区用户为 ContiNew 项目贡献力量,包括但不限于 Issue 排查、测试验证、代码开发与重构等。每一份贡献,都是推动项目进步的重要力量。
贡献必读
如果您是开源贡献新手,建议先阅读以下文档,了解参与开源项目的流程与最佳实践:
文档 | 简介 |
---|---|
《开源项目礼节》 | 涵盖开源协作中的最佳实践,帮助您在社区中获得尊重并保持高效协作 |
《如何为开源做贡献》 | 专为初学者准备的开源贡献指南,从基础知识到实践步骤一应俱全 |
分支说明
ContiNew 系列项目采用清晰的分支策略,确保开发与维护有序进行。提交 PR 前,请确认目标分支是否处于活跃维护状态:
分支 | 说明 |
---|---|
dev | 开发分支,用于下个大版本的 SNAPSHOT 开发,接受新功能或功能优化 PR |
x.x.x | 维护分支,用于特定版本(如 vx.x.x)的 bug 修复,仅接受已有功能的修复 PR,不接受新功能 |
贡献代码
若您希望提交新功能或优化现有代码,请遵循以下步骤:
- 在开源平台上将项目 fork 到您的个人仓库
- 将 fork 的项目克隆到本地开发环境
- 基于当前维护的分支(如 dev)创建新分支(如 feat/newFeature),请勿直接修改源分支(源分支仅做同步 ContiNew 最新代码用)
- 在新分支上进行代码修改,完成后提交并 push 到您的远程仓库
- 在开源平台上创建 pull request (PR),选择正确的源分支和目标分支,按模板填写说明信息(参考 已合并的 PR 可提高合并率)
- 提交 PR 后,系统会提示签署 CLA(贡献者协议)。请确保 commit 使用的邮箱与平台绑定邮箱一致(如果不一致,可以在本地通过
git reset --soft HEAD~1
回退,然后使用正确邮箱重新提交,最后git push -f
即可,不需要重新创建 PR),然后使用该邮箱签署即可 - 耐心等待维护者审核并合并您的 PR(建议通过交流群进行快捷沟通)
- PR 合并后,下次贡献前请先同步最新代码,再重复步骤 3 开始
以下是向 continew-admin
项目提交 PR 的简化流程:
1. continew/continew-admin -> fork -> your/continew-admin
2. git clone your/continew-admin.git
3. git checkout -b feat/newFeature
4. 在 feat/newFeature 分支开发并 git push -u feat/newFeature
5. 提交 PR: your/continew-admin:feat/newFeature -> continew/continew-admin:dev
6. 阅读并签署 CLA
7. PR 合并后,git branch -d feat/newFeature
8. 下次:从 continew/continew-admin 同步最新代码到 your/continew-admin,然后重复步骤 3...
温馨提示
为了确保项目质量和协作效率,请注意以下事项:
- 代码和配置文件请参考已有风格,遵循清晰的结构与命名规范,提供完善的注释(包括接口文档和参数示例),后端代码请符合阿里巴巴 《Java开发手册(黄山版)》 中的代码规范
- 提交后端代码前请关闭所有代码窗口,执行
mvn compile
命令进行代码格式化(ContiNew 项目后端编译时会自动执行插件进行代码格式修正)。编译通过后请勿再次打开代码窗口,避免不同 IDE 配置导致的格式差异 - 提交时,请按照 Angular 提交规范 编写 commit message(参考已有风格)