🎉 我们热烈欢迎且感谢各位参与本项目的开发工作,目前您可以通过以下方式参与。
你可以在 Issues 中提出意见或建议,我们将尽快回复并对项目做出调整。
如果你选择提交 PR,请先了解以下内容,否则你的 PR 暂不会被合并,或要求修改后合并。
- 请勿提交与管家无关或对管家无故诋毁的内容。
- 请在提交 commit 时遵守本项目的 commit message 相关规则
- 对于文档中的内容,请在中英文之间打上空格以保持美观。
- 请遵守一定的文件/代码内命名规则,如驼峰命名法。
- 转载相关文献时遵守其协议。
本项目的 commit message 要求必须分为三段,以下是一个标准的 commit message 实例:
[en] appendix: Correct a grammer mistake in repair-system-image
- 第 1 段:要求用半角方括号包裹住修改内容所属的语言。如果与文档内容无关(如更正配置等),请将其改为
[non-related]
,这种 commit 的 commit message 的后文不受下述规则的限制。 - 第 2 段:要求写出修改内容所属文件的目录。如果该文件在根目录,则直接写其不带扩展名的文件名。(注:该段为可选段)
- 第 3 段:要求用一句英语简短地概述你所做的更改。