贡献指南
感谢你对 Answer 的贡献兴趣!
如何贡献
你可以通过提交 PR 直接贡献到 github 仓库中。
创建问题
- 如果你有任何问题,请随时提问。
创建 Pull Request
- 我们感谢你抽出时间做出贡献!在提交 Pull Request 之前,请创建一个解释错误或功能请求的问题,并告诉我们你计划为其创建 Pull Request。如果问题已经存在,请在该问题上发表评论,让我们知道你想要为其提交 Pull Request。这有助于我们跟踪 Pull Request 并确保没有重复的工作。
提交信息准则
<type>(<scope>): <subject>
type
- feat: 新特性
- fix: 修复 bug
- docs: 仅文档更改
- style: 不影响代码含义的更改(空格,格式,缺少分号等)
- refactor: 既不修复 bug 也不添加特性的代码更改
- perf: 提高性能的代码更改
- test: 添加缺失的测试
- chore: 构建过程或辅助工具和库(例如文档生成)的更改
scope
scope 可以是指明提交更改的位置的任何内容。
subject
subject 包含对更改的简洁描述:
- 使用命令式,现在时: "change" 而非 "changed" 或 "changes"
- 不要大写第一个字母
- 不要在末尾放置句号
- 整个提交消息的长度不得超过 50 个字符
- 描述提交的内容,而不是它所涉及或修复的问题
- 简要但具有描述性 - 通过阅读主题,我们应该对提交的内容有很好的理解