Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 2.6 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.

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:

  • cat-bug
  • cat-feature
  • cat-chore
  • cat-performance

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-confirmation, needs-repro-script, needs-discussion tags, it may not be wise to start working on these issues.

Here are a few quick links to get you started:

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.