diff --git a/lang/en/org/contributing.md b/lang/en/org/contributing.md index 21bef2b06..1b1e8ae04 100644 --- a/lang/en/org/contributing.md +++ b/lang/en/org/contributing.md @@ -30,14 +30,24 @@ Here are a few quick links to get you started: If you would like to start triaging issues, one easy way to get started is to [subscribe to yarn on CodeTriage](https://www.codetriage.com/yarnpkg/yarn). +## Setup + +1. Ensure Node.js 4+ and a non-development version of Yarn are installed. +1. Git clone the [Yarn repository](https://github.com/yarnpkg/yarn). +1. From the root of the repository, run `yarn` to install the dependencies required for development. + ## Building +Perform a one-off build using: + ```sh -yarn run build +yarn build ``` +Or to automatically rebuild as changes are made, use: + ```sh -yarn run watch +yarn watch ``` ## Testing Your Changes Locally @@ -51,12 +61,22 @@ You can now proceed to run `yarn watch` in one tab, and test with `yarn-local` i ## Testing +First follow the building instructions above. + +Then to run both the linters and tests, use: + +```sh +yarn test +``` + +Or to run them separately, use: + ```sh -yarn run test +yarn lint ``` ```sh -yarn run lint +yarn test-only ``` ## Pull Requests