贡献指南

ContiNew（Continue New）系列项目致力于持续迭代，提供舒适的开发体验。作为开源社区，Creator 的初衷是希望 ContiNew 系列项目能够通过开源协作模式，提升技术透明度、放大集体智慧、共创优秀实践，源源不断地为企业级项目开发提供助力。

我们诚挚邀请广大社区用户为 ContiNew 项目贡献力量，包括但不限于 Issue 排查、测试、代码开发与重构等。

贡献必读

即使你目前是一位贡献新手，不妨先阅读一些文档，了解一下参与开源项目的流程细节。

文档	简介
《开源项目礼节》	一些可供实行的最佳实践，确保你感到受重视和安心，并保持生产力。
《如何为开源做贡献》	想为开源贡献力量？本指南为"菜鸟"和初学者而准备！

分支说明

ContiNew 系列项目的分支，目前均分为下个大版本的开发分支和上个大版本的维护分支，PR 前请注意对应分支是否处于维护状态。

分支	说明
dev	开发分支，默认为下个大版本的 SNAPSHOT 版本，接受新功能或新功能优化 PR
x.x.x	维护分支，在 vx.x.x 版本维护期终止前（一般为下个大版本发布前），用于修复上个版本的 Bug，只接受已有功能修复，不接受新功能 PR

贡献代码

如果您想提交新功能或优化现有代码，可以按照以下步骤操作：

1. 首先，在 Gitee 或 Github 上将项目 fork 到您自己的仓库
2. 然后，将 fork 过来的项目（即您的项目）克隆到本地
3. 基于当前仍在维护的分支（例如：dev），切出来一个新的分支（例如：feat/tenant）（不要修改源分支，源分支仅做同步 continew 最新代码用）
4. 在新分支开始修改代码，修改完成后，将代码 commit 并 push 到您的远程仓库
5. 在 Gitee 或 Github 上新建 pull request（pr），选择好源和目标，按模板要求填写说明信息后提交即可（多多参考 已批准合并的 pr 记录，会大大增加批准合并率）
6. 最后，耐心等待维护者合并您的请求即可
7. PR 合并后，下次 PR 时请先同步最新代码，然后再次从步骤 3 开始

以下是向 continew-admin 项目提交 pull request 为例的简单步骤：

1.continew/continew-admin -> fork -> your/continew-admin
2.git clone your/continew-admin
3.dev -> feat/tenant
4.feat/tenant 本地开发，开发完 push 到 your/continew-admin
5.your/continew-admin:feat/tenant -> continew/continew-admin:dev
6.PR 合并完成，删除 feat/tenant 分支
7.强制从 continew/continew-admin 覆盖更新 your/continew-admin，然后重复步骤 3...

请记住，如果您在参与贡献时有任何疑问或需要帮助，我们将随时提供支持。

温馨提示

欢迎大家为 ContiNew 系列项目贡献代码，我们非常感谢您的支持！为了更好地管理项目，我们有一些提醒：

1. 请确保代码、配置文件的结构和命名规范良好，完善的代码注释甚至包括接口文档参数示例，并遵循阿里巴巴的 《Java开发手册(黄山版)》 中的代码规范，保证代码质量和可维护性
2. 在提交代码前，请按照 Angular 提交规范 编写 commit 的 message（建议在 IntelliJ IDEA 中下载并安装 Git Commit Template 插件，以便按照规范进行 commit）
3. 提交代码之前，请关闭所有代码窗口，执行 mvn compile 命令（代码格式化插件会在项目编译时对全局代码进行格式修正），编译通过后，不要再打开查看任何代码窗口，直接提交即可，以免不同的 IDE 配置会自动进行代码格式化