- Find things to work on
- 构建
- 使用本地构建版本
- 测试
- 合并请求
- 授权协议
欢迎参与贡献,无论大小。贡献之前,请先阅读 代码规则。
Find things to work on
需要帮助改进的issue除了被打上了help wanted
的标签的以外,也被分为如下几类:
- cat-bug
- cat-feature
- cat-chore
- cat-performance
以上是你可以使用的主要类别。 另外,我们还会使用high-priority
和good first issue
标签来分别表示issue的重要程度和容易上手的程度。 如果issue没有被打上triaged
标签,或者被打上了needs-confirmation
、needs-repro-script
、needs-discussion
之一,那么你或许可以先别急着动手修改。
你可以从以下链接开始你的贡献之路:
- 适合上手修复的缺陷
- 适合上手实现的特性
- 需要帮忙的重要问题
- 需要重现方法的问题
- Issues need triaging
If you would like to start triaging issues, one easy way to get started is to subscribe to yarn on CodeTriage.
构建
yarn run build
yarn run watch
使用本地构建版本
alias yarn="node /path/to/yarn/lib/cli/index.js"
测试
yarn run test
yarn run lint
合并请求
我们积极欢迎您的合并请求。
- Fork 仓库并从
master
创建你的分支。 - 如果你添加了一些需要测试的代码,请同时添加一些测试方法、用例。
- 如果你修改了 API,请更新文档。
- 确保测试集运行通过。
- 确保你的代码通过代码风格检查(Code Lint)。
授权协议
要贡献给 Yarn,你要同意你的贡献在 BSD协议下授权。
原文: https://yarnpkg.com/zh-Hans/org/contributing