babel/CONTRIBUTING.md
Jesse McCarthy 0a4a0d8cd2 Update CONTRIBUTING.
* Add note about unbuildable versions.
* Remove links to removed sections.
2015-07-15 11:08:34 -04:00

1.4 KiB

NOTE: BEFORE OPENING AN ISSUE READ SEE THE README.


Setup | Running tests | Internals


Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Developing

Note: Versions < 5.1.10 can't be built.

Setup

$ git clone https://github.com/babel/babel
$ cd babel
$ make bootstrap

Then you can either run:

$ make build

to build Babel once or:

$ make watch

to have Babel build itself then incrementally build files on change.

If you wish to build a copy of Babel for distribution then run:

$ make build-dist

and access the files from packages/babel/dist.

Running tests

You can run tests for all packages via:

$ make test

This is mostly overkill and you can limit the package to a select by using the TEST_ONLY environment variable:

$ TEST_ONLY=babel-cli make test

Use the TEST_GREP variable to run a subset of tests by name:

$ TEST_GREP=transformation make test

Internals

Please see /doc for internals documentation relevant to developing babel.