Unverified Commit 988f5d10 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Add extra step to contributing steps (#9377)

parent 00badd4d
...@@ -3,11 +3,12 @@ ...@@ -3,11 +3,12 @@
Our Commitment to Open Source can be found [here](https://zeit.co/blog/oss) Our Commitment to Open Source can be found [here](https://zeit.co/blog/oss)
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
2. Install yarn: `npm install -g yarn` 2. Create a new branch `git checkout -b MY_BRANCH_NAME`
3. Install the dependencies: `yarn` 3. Install yarn: `npm install -g yarn`
4. Run `yarn dev` to build and watch for code changes 4. Install the dependencies: `yarn`
5. In a new terminal, run `yarn types` to compile declaration files from TypeScript 5. Run `yarn dev` to build and watch for code changes
6. The development branch is `canary` (this is the branch pull requests should be made against). On a release, the relevant parts of the changes in the `canary` branch are rebased into `master`. 6. In a new terminal, run `yarn types` to compile declaration files from TypeScript
7. The development branch is `canary` (this is the branch pull requests should be made against). On a release, the relevant parts of the changes in the `canary` branch are rebased into `master`.
> You may need to run `yarn types` again if your types get outdated. > You may need to run `yarn types` again if your types get outdated.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment