Skip to content
本页目录

贡献准则

很高兴你有兴趣为 Keep 主题参与代码贡献,在进行代码贡献之前,请务必花一些时间通读以下准则:

Pull Request 准则

master 分支只是最新稳定版本的一个快照。所有的开发都应该在专门的开发分支中进行,因此不要向 master 分支提交 PR

PR 流程:

  • Keep 主题仓库 fork 到你的 Github 账号下,并克隆(git clone) 你的 Keep 主题仓库到本地。
  • 切换到dev分支上开发。
  • 将你的本地修改进行提交。
  • 将提交 push 到 fork 的仓库下。
  • 创建一个 Pull request 到 Keep 主题仓库的 dev 分支。

开发之前的准备

请确保你的本地环境正确安装 Node.jsNPM 和 Git。

注意

Node.js 版本需 >= 14.0

提交(commit)信息规范

我们对项目的 git 提交信息格式进行统一格式约定,每条提交信息由 type + subject 组成,这将提升项目日志的可读性。

  • type 用于描述此次提交信息的意义,全小写,仅包括如下类型:
    • feat:新功能
    • fix:Bug 修复
    • refactor:重构(既不是新增功能,也不是修改 Bug 的代码变动)
    • docs:文档变化
    • style:代码格式变化(空格、缩进、换行、分号等)
    • test:代码测试相关
    • chore:基础构建工具或依赖库的变化(不涉及源码)
    • revert:代码回滚(回退已经存在的 commit
  • subject 用于简要描述修改变更的内容,如 update quick start in readme.md
    • 句尾不要使用符号
    • 使用一般现在时、祈使句语气

Keep To do List

详情查看:

https://github.com/XPoet/hexo-theme-keep/projects/1

贡献者

这个项目的存在多亏了所有的贡献者

Released under the AGPL-3.0 License