CONTRIBUTING.md

贡献

感谢您对 Guppy 的兴趣! 我们对社区的任何贡献表示 欢迎和感激. 我们希望Guppy 成为一项社区活动,我们所有人共同努力,让那些 没有终端经验 的人们更容易进行网页开发!

报告问题和提出问题

在打开问题之前,请搜索问题跟踪器确保您的问题尚未报告.

错误和改进

Guppy是alpha软件,你可能会遇到一些问题.

我们使用 问题跟踪器 来跟踪 Guppy本身,其示例和文档的错误和改进. 我们鼓励您 打开讨论 改进,架构,理论,内部实现 等问题. 如果之前讨论过某个主题,我们将要求您加入之前的讨论.

开发

访问问题跟踪器找到需要注意的 open 问题列表. 贡献的最佳方式是,找到你能够并且愿意解决的问题. 随着项目的成熟,我们希望为 新的React开发人员 添加更多"good first contribution"问题.

Fork,然后 clone repo :

git clone https://github.com/your-username/guppy.git

运行

本地开发

您可以通过运行本地开始本地开发start任务:

npm run start

这应该打开一个运行应用程序的 Electron窗口.

在开发过程中,所有项目都是在~/guppy-projects-dev

您可以运行以下命令来构建MacOS可执行文件:

npm run package

结果将在release-builds文件夹.

测试和类型检查

不幸的是,Guppy 目前很少是正在测试.

我们希望在此期间添加更多测试,以及 添加CI集成 运行测试,但是现在您可以使用以下命令运行测试:

npm run test

该项目使用 Flow,可以使用以下方法检查类型:

npm run flow

这个项目使用 Prettier,这应该在提交时自动运行.

文档

请在项目中了解更多关于 Guppy的信息自述,或位于/docs目录.

发送拉取请求

对于 非平凡的更改,请在开始工作之前,打开有关 新功能或重构 的提案的问题,或对 现有的请求功能问题 发表评论. 我们不希望,您在我们不想接受的拉动请求上浪费您的努力.

另一方面,有时是 开始对话的最佳方式是发送拉取请求. 用你最好的判断!

通常,贡献工作流程如下所示:

• 找到或打开一个新问题在问题跟踪器.
• Fork 本项目
• 基于master分支创建一个新的功能分支.
• 确保所有测试都通过
• 提交拉取请求,引用它解决的任何问题.

请尽量将 拉取请求集中在规范内,避免包含不相关的提交.

在您提交了拉取请求后,我们会尽快回复您. 我们可能会建议一些变化或改进.

谢谢你的贡献!