# 贡献准则

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

# Pull request 准则

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

  • 将仓库 fork 到你的 Github,并 clone 到本地
  • 切换到新分支(例如 patch-1)上开发
  • 将本地修改进行提交
  • 将提交 push 到 fork 的仓库下
  • 创建一个 Pull request 到 Keep 主题仓库的 dev 分支

# 开发之前的准备

请确保你的本地环境正确安装 Node.js (opens new window)npm (opens new window)和 Git。

# 提交信息规范

我们对项目的 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

# Completed 已完成

  • 响应式设计,适配平板/手机
  • 日间/夜间模式自由切换
  • 多种代码高亮方案
  • 多语言,目前仅支持中/英文
  • 内置多款评论插件
  • 支持全站文章搜索
  • 支持文章顶置
  • 代码块一键复制
  • TOC 目录结构
  • RSS 订阅
  • 网站 UV 和 PV 统计
  • 文章阅读次数、字数和阅读时长统计
  • 文章页大图查看器
  • 文章版权信息
  • 在线更改字号
  • 页面滚动进度条提示
  • 一键快速回到顶部
  • 支持 CDN
  • 支持 PJAX
  • 图片懒加载

# Unfinished 未完成

  • 文章点赞功能
  • 代码块折叠
  • 在线更改字体
  • 打赏功能
  • 左上角增加 logo 配置
  • 头部菜单栏优化(透明、半透明)
  • 文章 meta 增加评论数量
  • 微信分享二维码生成
  • 分类页面优化(折叠、缩进、层级、字体大小、文章数量)
  • 增加 Disqus 评论系统
  • ......

# 贡献人员

感谢所有为 Keep 主题做出贡献的人!