cerxes/babel
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

contributing.md updates [skip ci] (#11403)

Browse Source 
* contributing.md updates [skip ci]

* [skip ci]

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-Authored-By: Brian Ng <bng412@gmail.com>

* Use Yarn > 1

Co-authored-by: Brian Ng <bng412@gmail.com>
Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>
This commit is contained in:
Henry Zhu 2020-04-14 09:27:15 -04:00 committed by GitHub
parent a466f9c310
commit aaced0156d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -16,9 +16,7 @@
# Contributing # Contributing
Contributions are always welcome, no matter how large or small. Before Contributions are always welcome, no matter how large or small! Before contributing, please read the [code of conduct](https://github.com/babel/babel/blob/master/CODE_OF_CONDUCT.md).
contributing, please read the
[code of conduct](https://github.com/babel/babel/blob/master/CODE_OF_CONDUCT.md).
## Not sure where to start? ## Not sure where to start?
@ -39,12 +37,9 @@ Feel free to check out the `#discussion`/`#development` channels on our [Slack](
## Developing ## Developing
**Note:** Versions `< 5.1.10` can't be built. *Node*: Check that Node is [installed](https://nodejs.org/en/download/) with version 10 and up. You can check this with `node -v`.
Babel is built for Node 6 and up but we develop using Node 8 and yarn. You can check this with `node -v`. *Yarn*: Make sure that Yarn 1 is [installed](https://classic.yarnpkg.com/en/docs/install) with version >= `1.19.0`.
Make sure that Yarn is installed with version >= `0.28.0`.
Installation instructions can be found here: https://yarnpkg.com/en/docs/install.
### Setup ### Setup
@ -72,7 +67,7 @@ $ make watch
to have Babel build itself and incrementally build files on change. to have Babel build itself and incrementally build files on change.
You can access the built files for individual packages from `packages/<package-name>/lib`. > You can access the built files for individual packages from `packages/<package-name>/lib`.
If you wish to build a copy of Babel for distribution, then run: If you wish to build a copy of Babel for distribution, then run:
@ -109,9 +104,7 @@ If you just want to run all tests:
$ make test-only $ make test-only
``` ```
Most likely you'll want to focus in on a specific issue. When working on an issue, you will most likely want to focus on a particular [packages](https://github.com/babel/babel/tree/master/packages). Using `TEST_ONLY` will only run tests for that specific package.
To run tests for a specific package in [packages](https://github.com/babel/babel/tree/master/packages), you can use the `TEST_ONLY` environment variable:
```sh ```sh
$ TEST_ONLY=babel-cli make test $ TEST_ONLY=babel-cli make test