👍 感谢你愿意抽出宝贵时间为 Matcha 做出贡献!
我们欢迎一切形式的贡献,并对每一位贡献者表示衷心的感谢! 💖
在开始贡献之前,请仔细阅读本指南,以确保你的贡献符合项目要求。
Tip
如果你是首次参与开源项目,建议先阅读《如何为开源做贡献》。
在使用 Matcha 过程中遇到问题时,请先搜索存储库中的现有问题列表。如果未找到类似问题,请创建一个新的 issue。
报告错误时,请提供以下信息:
- 详细的错误描述
- 重现问题的步骤
- 期望的行为
- 错误消息
- 运行环境
你提供的信息越详细,我们就能越快地帮助你解决问题。
如果你有新的功能想法或其他项目创意,请在 issue 或 discuss 中提出。
建议格式:
- 清晰描述所需特性
- 如有可能,提供你认为可行的解决方案
公开讨论将有助于开发者和社区更好地理解你的意图。
在创建 Pull Request 之前,建议先发布或打开 issue 以报告错误或提议新功能,并与开发者和社区成员进行讨论。
如果你希望针对某个 issue 修复错误或实现功能,最好在此 issue 下发表评论,并与他人讨论你提出的解决方案。
- Fork 项目:点击仓库页面的 "Fork" 按钮。
- 创建分支:
git checkout -b feature/你的功能名称
你需要安装以下工具:
安装依赖:
bun install启动开发模式:
bun devMatcha 使用 eslint 和 stylelint 规范代码风格。请确保你的代码与项目现有代码风格一致,变量命名清晰,并包含适当的注释和测试代码。
检查代码风格:
bun lint修复代码问题:
bun lint:fix我们采用 gitmoji 规范,使用 emoji 来清晰地描述提交的目的。
提交信息示例:
git commit -m '🐛 修复了某个问题'请确保每个 commit 只包含一个意图,并清晰地描述其目的。
在发起 Pull Request 之前,请先在本地运行 bun build,确保你的修改能正确构建。
PR 建议:
- 仅包含与你的更改直接相关的文件。
- 尽量分散提交涉及少量文件的 PR,避免提交涉及多个文件的大型 PR。
PR 描述:
- 简要说明更改的内容和目的。
- 如有必要,提供相关 issue 的链接。