贡献指南
很高兴您有兴趣为 Keep 主题参与代码贡献,包括但不限于:美化 UI 界面、增加新功能、性能优化、修复 Bug、完善文档等。
在进行代码贡献之前,请务必花一点时间通读以下注意事项:
技术栈
你只需熟悉以上相关技术栈,便可轻松参与 Keep 主题开发。
贡献流程
- 查看 Keep 主题 To do list
- 领取对应的 To do
- 代码开发 & 自测
- 提交 & 发起 PR
- 作者合并
参与代码贡献过程中,遇到任何问题都可以随时联系作者寻求技术支持。
开发之前的准备
请确保你的本地环境正确安装 Node.js、NPM 和 Git。
注意
Node.js 版本需 >= 14.0
代码格式化
Keep 主题使用 husky 在 git commit
时对 JavaScript 和 Stylus 代码进行格式化,请确保您编写的代码通过格式化。
提交规范
Keep 主题使用社区最流行、最知名、最受认可的 Angular 团队代码提交规范,你在提交代码时填写的描述信息,请遵循该规范。
git commit
格式:
<type>(<scope>): <subject>
type
type 用于说明 commit 的提交类型(必须是以下几种之一)。
类型 | 描述 |
---|---|
feat | 新增一个功能 |
fix | 修复一个 Bug |
docs | 文档变更 |
style | 代码格式(不影响功能,例如空格、分号等格式修正) |
refactor | 代码重构 |
perf | 改善性能 |
test | 测试 |
build | 变更项目构建或外部依赖(例如 scopes: webpack、gulp、npm 等) |
ci | 更改持续集成软件的配置文件和 package 中的 scripts 命令,例如 scopes: Travis, Circle 等 |
chore | 变更构建流程或辅助工具 |
revert | 代码回退 |
scope
scope 用于指定本次 commit 影响的范围。(可选)
subject
subject 是本次 commit 的简洁描述,长度约定在 50 个字符以内,通常遵循以下几个规范:
- 用动词开头,第一人称现在时表述,例如:change 代替 changed 或 changes
- 第一个字母小写
- 结尾不加句号(.)
commit 示例
// 示例 1
perf: optimize article page render
// 示例 3
docs: update README
注意
给 Keep 主题提 PR 的 git commit
的描述信息必须使用英文
致谢
这个项目的存在多亏了所有的贡献者,在此表示感谢。