Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 2.19 KB

贡献指南

首先感谢您考虑为我们的项目做出贡献!

秉持 “如无必要,勿增实体” 的原则,此仓库仅接受与全局规则相关的维护或改进 issues 或 PR 提交。

同时本项目的目标是编写尽量精简通用的规则,所以部分针对APP的规则可能已存在全局规则中,希望您多留意

同时我们十分欢迎您贡献精简通用的规则, 全局规则, 优化已存在规则。这是我们当前最需要的

如果您需要任何额外的 APP 规则,您需要自行编写规则并将其添加到本地规则中使用。

提交规则需知

我们希望您在提交规则之前应该做到以下几点:

  • 只维护或改进提交全局规则或, 优化已存在规则。
  • 非必须勿添加新规则组,而是考虑将其添加到已存在的规则组 rules 中。

同时,我们的最新规则是基于 dev 分支的,当你打算贡献规则时应该基于 dev 分支 fork 开发,并提交到 dev 分支。

Pull Request 指南

为了使贡献过程更加顺畅和高效,您应该遵循以下指南。

该规范有助于保持清晰和信息丰富的提交历史,使每个人更容易理解变更。

在提交 Pull Request 之前,请确保您的更改遵循以下约定:

  • 您的 Pull Request 标题应该遵循以下模式:

      <type>(APP name): <subject>
    
  • type:提交类型,应该是以下之一:

    • feat: 新功能
    • fix: 修复 bug
  • 您的代码更改应该有良好的文档并保持清晰的提交历史。

  • 以下类型的 Pull Request 将不会被接受:

    • 未经测试的代码更改
    • 未经文档化的代码更改
    • 未经测试的文档更改

为什么规范提交消息?

在日常开发工作中,使用 Git 管理代码变更很常见。然而,如果不关注提交消息的质量,可能会导致不清晰和无效的历史记录。提交消息的规范增强了可读性和实用性。

行为准则

请在所有交互和贡献中遵守我们的行为准则