Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.
Find things to work on
We label issues that we need help with the
help wanted tag. We also categorize them with the following tags:
These are the main categories that you can work on. We further mark issues with a
high-priority tag or a
good first issue tag to indicate their importance to the project and subjective level of easiness to get started on respectively. If you don’t see the
triaged tag or you see any of the
needs-discussion tags, it may not be wise to start working on these issues.
Here are a few quick links to get you started:
- Good first bugs
- Good first features
- High impact issue that need help
- Issues need reproduction scripts
- Issues need triaging
If you would like to start triaging issues, one easy way to get started is to subscribe to yarn on CodeTriage.
- Ensure Node.js 4+ and a non-development version of Yarn are installed.
- Git clone the Yarn repository.
- From the root of the repository, run
yarnto install the dependencies required for development.
Perform a one-off build using:
Or to automatically rebuild as changes are made, use:
Testing Your Changes Locally
You can modify the following command to allow you to test your changes locally such that it doesn’t override an existing installation of
- Navigate to the folder for yarn that you cloned from GitHub
alias yarn-local="node $PWD/lib/cli/index.js". This will map
index.jsfile in your current working directory.
You can now proceed to run
yarn watch in one tab, and test with
yarn-local in the other.
First follow the building instructions above.
Then to run both the linters and tests, use:
Or to run them separately, use:
We actively welcome your pull requests.
- Fork the repo and create your branch from
- If you’ve added code that should be tested, add tests.
- If you’ve changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
By contributing to Yarn, you agree that your contributions will be licensed under its BSD license.