Skip to content

Latest commit

 

History

History
65 lines (35 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

65 lines (35 loc) · 2.66 KB

参与贡献

👍 感谢您愿意抽出宝贵时间为 Matcha 做出贡献!

我们欢迎一切贡献!并对每个愿意贡献的人表示衷心的感谢! 💖

在提交贡献之前,请先阅读本贡献指南以确保您的贡献符合项目要求。

如果您正在尝试做出您的第一个贡献,您可以先阅读《如何为开源做贡献》

报告错误

如果您在使用 Matcha 过程中遇到了问题,请首先搜索存储库上的现有问题列表。如果找不到类似的问题,请创建一个新的 issue。

在报告错误时,请提供尽可能多的信息:错误的细节、重现问题的步骤、期望的行为、错误消息以及运行环境等。您在某个问题上投入的时间越多,我们就越能为您提供更好的帮助。

功能建议

在 issue 或者 discuss 中讨论高级主题或想法(例如,社区、愿景或政策),或是提出新功能或其他项目创意。

为了让开发者更好地理解您的意图,请认真描述您所需要的特性,可能的话可以提出您认为可行的解决方案。

编写代码

在创建 Pull Request 之前,最好先发布或打开 issue 以报告错误或提议新功能,并与开发者和社区其他成员进行公开讨论。

如果您希望为某个尚未解决的问题修复 bug 或实现功能,最好根据自己的意图对单个问题发表评论,并与他人讨论您提出的解决方案。

准备工作

fork 本项目并创建一个分支。

开发环境

您需要准备 node18 和 pnpm8 以及 rust 工具链。

运行以下命令安装依赖并启动 Matcha 开发模式:

pnpm i && pnpm tauri dev

代码风格

Matcha 使用 eslint 和 stylelint 规范代码风格,请确保您的代码风格和项目已有的代码保持一致,变量命名清晰,有适当的注释与测试代码。

您可以运行 lint 命令来检查您的代码是否符合规范:

pnpm lint && pnpm lint:style

Commit 规范

我们采用 gitmoji 规范,它是一种基于 emoji 的提交信息规范,可以用来清晰地描述提交的目的。

请确保您的每一个 commit 都能清晰地描述其意图,一个 commit 尽量只有一个意图。

Pull Request

发起拉取请求之前,请先在本地运行 pnpm tauri build,以确保你的修改能正确构建。

为了帮助进行代码审查,请在拉取请求中仅包含与您的更改直接相关的文件,不要包含不相关的更改。

通常,最好分散提交涉及少量文件的拉取请求,而不是提交涉及多个文件的大型拉取请求。