diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7af0333ec3..2f47779de3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,10 +27,10 @@ Contributions are always welcome, no matter how large or small. - If you aren't just making a documentation change, you'll probably want to learn a bit about a few topics. - [ASTs](https://en.wikipedia.org/wiki/Abstract_syntax_tree) (Abstract Syntax Tree): The Babel AST [spec](https://github.com/babel/babylon/blob/master/ast/spec.md) is a bit different from [ESTree](https://github.com/estree/estree). The differences are listed [here](https://github.com/babel/babylon#output). - - This repository [`/doc`](https://github.com/babel/babel/tree/master/doc) contains the notes on Babel's internals + - Check out [`/doc`](https://github.com/babel/babel/tree/master/doc) for information about Babel's internals - Check out [the Babel Plugin Handbook](https://github.com/thejameskyle/babel-handbook/blob/master/translations/en/plugin-handbook.md#babel-plugin-handbook) - core plugins are written the same way as any other plugin! - Check out [AST Explorer](http://astexplorer.net/#/scUfOmVOG5) to learn more about ASTs or make your own plugin in the browser -- When you feel ready to finally jump into the Babel source code, a good start is to look out for issues which are labeled with [help-wanted](https://github.com/babel/babel/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and/or [beginner-friendly](https://github.com/babel/babel/issues?q=is%3Aissue+is%3Aopen+label%3A%22beginner-friendly%22). +- When you feel ready to jump into the Babel source code, a good place to start is to look for issues tagged with [help-wanted](https://github.com/babel/babel/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and/or [beginner-friendly](https://github.com/babel/babel/issues?q=is%3Aissue+is%3Aopen+label%3A%22beginner-friendly%22). ## Chat @@ -40,7 +40,7 @@ Feel free to check out the `#discussion`/`#development` channels on our [Slack]( **Note:** Versions `< 5.1.10` can't be built. -Babel is built for Node 4 and up but we develop using Node 6. Make sure you are on NPM 3. +Babel is built for Node.js 4 and up but we develop using Node.js 6. Make sure you are on npm 3. You can check this with `node -v` and `npm -v`. @@ -120,7 +120,7 @@ Use the `TEST_GREP` variable to run a subset of tests by name: $ TEST_GREP=transformation make test ``` -To enable the Node debugger added in v6.3.0, set the `TEST_DEBUG` environment variable: +To enable the Node.js debugger added in v6.3.0, set the `TEST_DEBUG` environment variable: ```sh $ TEST_DEBUG=true make test diff --git a/README.md b/README.md index 6db75a56dd..180168b5a4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ CircleCI Status Coverage Status Slack Status - NPM Downloads + npm Downloads

@@ -89,7 +89,7 @@ Our discussions/notes/roadmap: [babel/notes](https://github.com/babel/notes) ## Packages -The Babel repo is managed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md) that is composed of many NPM packages. +The Babel repo is managed as a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md) that is composed of many npm packages. ### Core Packages @@ -131,9 +131,9 @@ Check out the [`babel-handbook`](https://github.com/thejameskyle/babel-handbook/ - [`babel-types`](/packages/babel-types) is used to validate, build and change AST nodes. - [`babel-polyfill`](/packages/babel-polyfill) is [literally a wrapper](https://github.com/babel/babel/blob/master/packages/babel-polyfill/src/index.js) around [`core-js`](https://github.com/zloirock/core-js) and [regenerator-runtime](https://github.com/facebook/regenerator/tree/master/packages/regenerator-runtime). Check out the [docs](https://babeljs.io/docs/usage/polyfill/). - [`babel-runtime`](/packages/babel-runtime) is similar to the polyfill except that it doesn't modify the global scope and is to be used with [`babel-plugin-transform-runtime`](/packages/babel-plugin-transform-runtime) (usually in library/plugin code). Check out the [docs](https://babeljs.io/docs/plugins/transform-runtime/). -- [`babel-register`](/packages/babel-register) is a way to automatically compile files with babel on the fly by binding to NodeJS's `require`. Check out the [docs](http://babeljs.io/docs/usage/require/). -- [`babel-template`](/packages/babel-template) is a helper function to create AST nodes by passing a string representing the code instead of tediously building them using `babel-types`. -- [`babel-helpers`](/packages/babel-helpers) is a set of pre-made `babel-template` functions that are used in some babel plugins. +- [`babel-register`](/packages/babel-register) is a way to automatically compile files with Babel on the fly by binding to Node.js `require`. Check out the [docs](http://babeljs.io/docs/usage/require/). +- [`babel-template`](/packages/babel-template) is a helper function that allows constructing AST nodes from a string presentation of the code; this eliminates the tedium of using `babel-types` for building AST nodes. +- [`babel-helpers`](/packages/babel-helpers) is a set of pre-made `babel-template` functions that are used in some Babel plugins. - [`babel-code-frame`](/packages/babel-code-frame) is a standalone package used to generate errors that print the source code and point to error locations. ### [Presets](http://babeljs.io/docs/plugins/#presets)