协作
无论大小,都欢迎您做出贡献。在提供贡献之前,请阅读行为准则。
寻找可做的事情
我们将需要帮助的问题标记为 help wanted
标记。我们还会使用以下标记对它们进行分类
- cat-bug
- cat-feature
- cat-chore
- cat-performance
这些是您可以参与的主要类别。我们进一步通过使用 high-priority
标记或 good first issue
标记来 مشخص问题,以分别表示它们对该项目的重要性以及主观上来说入手它们的容易程度。如果您未看到 triaged
标记,或者您看到任何 needs-confirmation
、needs-repro-script
、needs-discussion
标记,那么开始处理这些问题可能不太明智。
以下是帮助您入门的几个快速链接
要开始分类问题,一个简单的入门方法是在 CodeTriage 上订阅 yarn。
安装
- 确保已安装 Node.js 4+ 和非开发版本的 Yarn。
- 从 Yarn 存储库中克隆 Git。
- 从存储库的根目录运行
yarn
以安装开发所需的依赖关系。
构建
使用以下命令执行一次性构建
yarn build
或者,为自动在更改发生时重建,请使用
yarn watch
在本地测试您的更改
您可以修改以下命令来允许您在本地测试您的更改,以便它不会覆盖已有的 yarn
安装。
- 导航到从 GitHub 克隆的 yarn 文件夹
- 运行
alias yarn-local="node $PWD/lib/cli/index.js"
。这会将yarn-local
映射到当前工作目录中的index.js
文件。
您现在可以在一个标签页中运行 yarn watch
,并在另一个标签页中使用 yarn-local
进行测试。
测试
首先按照上述构建说明操作。
然后,同时运行 linter 和测试,请使用
yarn test
或者,为分别运行它们,请使用
yarn lint
yarn test-only
合并请求
我们欢迎您的合并请求。
- 分叉存储库,并从
master
创建您的分支。 - 如果您已添加了应该测试的代码,请添加测试。
- 如果您已更改 API,请更新文档。
- 确保测试套件通过。
- 确保您的代码经过清理。
许可
通过对 Yarn 做出贡献,您同意您的贡献将根据其 BSD 许可 进行许可。