本项目的所有代码均使用基于 GNU General Public License v3.0 开源协议开源,并附加下列条款。部分衍生项目采用 MIT License 开源,请以目标仓库内的 LICENSE 文件与 README 说明为准
请依照开源协议规范进行二次开发和使用
此软件及其所有副本的源码、二次开发的软件及其所有副本的源码,上述所有源码内必须在其根目录的明显位置,注明其来源的源码地址、最初源码地址(即本组织下的仓库)、来源的源码的所有贡献者。
同时,在所有上述的源码的产生的发行版本、部署版本的程序的页面的明显位置,需要注明此发行版本的源码地址、最初源码地址(即本组织下的仓库)、发行版本的所有贡献者所有贡献者。
例如,若本项目的开发者为 A,而 B 通过复制本项目得到新的项目,并对其进行了修改,则 B 需要在新的项目下注明本项目的最初地址(即本项目)以及开发者 A 和 B。同时有 C 通过复制 B 的项目得到一个新的项目,C 没有修改其任何源码,而是使用此项目的源码进行商业活动,则 C 需要在新的项目下注明 B 的项目地址、本项目的最初地址、开发者 A 和 B,同时其商业活动的主页面上,应当注明 C 的项目地址、本项目的最初地址、开发者 A 和 B
请前往 官方文档 以获取更加详细的帮助
请前往 Issues 来发起一个提交
请依照下面的步骤进行
- fork 本仓库
- 从 master 处创建一个分支,其名称格式为 <type>/<name>。其中 <type> 为变更类型,请在下列选项中选择,而 <name> 为变更的具体内容,请使用小写字母并用 「-」 作为分隔符。例如
feature/blog-system
- feature: 新增功能
- bugfix: 修复 bug
- docs: 文档等其他的相关更新
- 在此新分支上,完成你的开发
- 测试你开发完成的程序,并逐一检查你新增加的功能是否完整合理
- 为你的开发添加单元测试,请保证此时,所有的单元测试均通过,且核心代码部分的单元测试覆盖率达到 80% 以上
- 向本仓库提交 pull request,请 pull 至最新的 release 分支,而不是 master 分支
- 等待 「我」 对你的代码进行 code review
- 根据 code review 内的评论,解决其中所有的问题
- 由 「我」 同意 pull request,并等待后续的测试完成后,「我」 将会把 release 代码同步至 master
- 至此,你已经完成了整个提交流程,你可以选择删除掉 fork 的仓库或者保留它
Thanks goes to these wonderful people (emoji key):
Mauve 💻 🤔 🚧 👀 |
This project follows the all-contributors specification. Contributions of any kind welcome!