Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 1.14 KB

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Substantial feature requests should be proposed as an RFC. Before contributing, please read the code of conduct.

Setup

You need at least the latest version of Node 6 to work on Yarn.

  1. Install yarn on your system: https://yarnpkg.com/en/docs/install
  2. Fork the repo: https://github.com/yarnpkg/yarn
  3. Run the following commands:
git clone YOUR_YARN_REPO_URL
cd yarn
yarn
yarn run build

Building

yarn run build
yarn run watch

Using the local builds

alias yarn="node /path/to/yarn/lib/cli/index.js"

Testing

yarn run test
yarn run lint

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

License

By contributing to Yarn, you agree that your contributions will be licensed under its BSD license.