From cfbabe80bb1cbb10a3e1342a15ce00fff7773777 Mon Sep 17 00:00:00 2001 From: Henry Zhu Date: Sat, 28 May 2016 10:18:11 -0400 Subject: [PATCH] Docs: add to getting started (#3512) [ci skip] --- CONTRIBUTING.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db8323156b..c3c349b3ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,16 @@ 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). +## Not sure where to start? + +- 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): Our current [spec](https://github.com/babel/babel/tree/master/doc/ast) is a bit different from [ESTree](https://github.com/estree/estree). + - [`/doc`](/doc) for notes on babel internals + - Check out [the babel plugin handbook](https://github.com/thejameskyle/babel-handbook/blob/master/translations/en/plugin-handbook.md#babel-plugin-handbook). Core babel plugins are written the same way as any other plugin! + - Checkout [AST Explorer](http://astexplorer.net/#/scUfOmVOG5) to learn more about ASTs or making your own plugin live + +> If you're stuck, feel free to check out the `#development` channel on our [slack](https://slack.babeljs.io). + ## Developing **Note:** Versions `< 5.1.10` can't be built. Make sure you are on npm 3. @@ -138,7 +148,3 @@ For `babylon` specifically, you can easily generate an `expected.json` automatic - actual.js - expected.json (will be generated if not created) ``` - -#### Internals - -Please see [`/doc`](/doc) for internals documentation relevant to developing babel.