archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add declaration files to the contributing guide (#7885)

Browse source
This commit is contained in:
Luis Fernando Alvarez D 2019-07-10 19:59:53 -05:00 committed by Joe Haddad
parent 2450c85e81
commit 6f9387f6cf
2 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
contributing.md
View file

@ -5,8 +5,11 @@ 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. Install yarn: `npm install -g yarn`
3. Install the dependencies: `yarn` 3. Install the dependencies: `yarn`
4. Run `yarn run dev` to build and watch for code changes 4. Run `yarn dev` to build and watch for code changes
5. The development branch is `canary`. On a release, the relevant parts of the changes in the `canary` branch are rebased into `master`. 5. In a new terminal, run `yarn types` to compile declaration files from TypeScript
6. The development branch is `canary`. 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.
## To run tests ## To run tests

1
package.json
View file

@ -18,6 +18,7 @@
"lint": "lerna run typescript && standard && standard --parser typescript-eslint-parser --plugin typescript \"packages/**/*.ts\"", "lint": "lerna run typescript && standard && standard --parser typescript-eslint-parser --plugin typescript \"packages/**/*.ts\"",
"lint-fix": "standard --fix && standard --fix --parser typescript-eslint-parser --plugin typescript \"packages/**/*.ts\"", "lint-fix": "standard --fix && standard --fix --parser typescript-eslint-parser --plugin typescript \"packages/**/*.ts\"",
"prettier": "prettier --write \"**/*.{js,jsx,json,ts,tsx,md,mdx,css,html,yml,yaml,scss,sass}\" && yarn lint-fix", "prettier": "prettier --write \"**/*.{js,jsx,json,ts,tsx,md,mdx,css,html,yml,yaml,scss,sass}\" && yarn lint-fix",
"types": "lerna run types --stream",
"typescript": "lerna run typescript", "typescript": "lerna run typescript",
"prepublish": "lerna run prepublish", "prepublish": "lerna run prepublish",
"publish-canary": "lerna version prerelease --preid canary --force-publish && release --pre", "publish-canary": "lerna version prerelease --preid canary --force-publish && release --pre",