贡献准则
我希望对开源有热情的朋友都来参与贡献 Jpom，让这个项目变的越来越好。
Jpom 作为开源项目，离不开社区的支持，欢迎任何人修改和提出建议。贡献无论大小，你的贡献会帮助背后成千上万的使用者以及开发者，你做出的贡献也会永远的保留在项目的贡献者名单中，这也是开源项目的意义所在！
参与 Jpom 功能包括但不限于如下：
赞赏也是对我们的支持，如果您觉得 Jpom 对您有帮助以及觉得 Jpom 不错都可以为进行💖赞赏支持
# 我要如何做才能成为 Committer
需要你对开源有热情，技术扎实，有一颗用爱发电的心。
你需要加入 Jpom 的社区群，如何加入请参考加入社区讨论，表示有意成为开发者。
你需要熟读源码，理解核心代码的逻辑。
然后可以去 gitee issue页 (opens new window)、github issue页 (opens new window) 查看 issue 列表并进行认领。
或者你有相关建议自己进行创建 issue 并进行修复也是可以的。
在相关 issue 下回复“认领”就可以了，然后私聊告诉我。如果已经有相关同学已经认领了，请不要重复认领。
完成 3个issue 并成功通过审核并合并，我会邀请你成为 Committer。
# 对于长期 Committer 的要求
- 需要对开源有热情，技术扎实，有一颗用爱发电的心。
- 理解核心代码逻辑。时刻保持学习的心。
- 需要每个月贡献至少 1个PR 并成功通过审核并合并。
- 需要参与社区群的建设，积极回答问题和进行宣传。
# 提交 PR
Jpom 的 PR 统一在 Gitee 平台 (opens new window)上进行提交，如果你不知道如何提交 PR，可以在 Gitee 平台里去学习。这里不作说明。
提 PR 有以下注意点。
- fork 后切换到
dev分支，请以这个分支为开发基准。 - 所有的 PR 提交到
dev分支，这个分支为开发分支。 - 当您对功能进行了新增、修复、优化功能均需要编写
CHANGELOG.md(CHANGELOG 规范如下)
# changelog 更新规范
在新加功能、修复bug、优化功能在完成时候都需要在 CHANGELOG.md 记录
- 如果是使用者反馈的bug，在修复后需要备注反馈人的昵称
- 如果是 issue 需要备注 issue 地址以及平台（Gitee、GitHub）
- 如果是 pr 需要备注 pr 地址以及平台（Gitee、GitHub）
- 根据变动情况确定影响范围：如果影响 只：
agent、server其中一个，就使用【agent】、【server】开头，如果都影响就不用 - 可以视情况添加其他说明：如提交记录
- emoji 表情参考：https://emojixd.com/ (opens new window)
# 代码贡献指南
# 贡献步骤
Fork 后会在你的帐号下多了一个和本仓库一模一样的仓库，把你帐号的仓库 clone 到本地。
注意替换掉链接中的
分支名和用户名。如果是贡献代码，分支名填
dev；如果是贡献文档，分支名填docsgit clone -b 分支名 https://gitee.com/用户名/Jpom.git1修改代码/文档，修改后提交上来。
# 把修改的文件添加到暂存区 git add . # 提交到本地仓库，说明你具体做了什么修改 git commit -m '填写你做了什么修改' # 推送到远程仓库，分支名替换成 dev 或者 docs git push origin 分支名1
2
3
4
5
6登录你的仓库，然后会看到一条 PR 请求，点击请求合并，等待管理员把你的代码合并进来。
# 项目分支说明
| 分支 | 说明 |
|---|---|
| master | 主分支，受保护分支，此分支不接受 PR。在 dev 分支后经过测试没问题后会合并到此分支。 |
| dev | 开发分支，接受 PR，PR 请提交到 dev 分支。 |
| docs | 项目文档分支，接受 PR，介绍项目功能、汇总常见问题等。 |
目前用到的主要是 dev 和 docs 分支，接受 PR 修改，其他的分支为归档分支，贡献者可以不用管。