docs(contributing): move to docs directory [skip ci] #735
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
+ Add docs about fixtures testing + Add some getting-started docs
| @@ -0,0 +1,27 @@ | |||
| # Debugging | |||
|
|
|||
| In your project, if you find that there is a bug that appears ONLY when you use BabelMinify, it's most likely that there is a bug in BabelMinify and you should definitely report it. Here are some guidelines that might help you drill down the issue. If it doesn't help you, you can of course create a minimal repro project with the bug and report it. | |||
There was a problem hiding this comment.
Can we extend this and add like
when you use BabelMinify standalone or babel-minify as a preset in babelrc
vigneshshanmugam
approved these changes
Nov 20, 2017
j-f1
reviewed
Nov 20, 2017
docs/debugging.md
Outdated
|
|
||
| If you get a syntax error at compile time, then it could be a few things: | ||
|
|
||
| 1. The parser itself doesn't handle the syntax being used (a [babylon](https://github.com/babel/babylon) bug). |
There was a problem hiding this comment.
Babylon is now inside the monorepo.
docs/debugging.md
Outdated
|
|
||
| 1. The parser itself doesn't handle the syntax being used (a [babylon](https://github.com/babel/babylon) bug). | ||
| 2. The code is actually invalid syntax. | ||
| 3. You didn't turn on the relevant Babel plugin for that syntax (if experimental). |
There was a problem hiding this comment.
Should this be in order by probability? (2-3-1)
|
|
||
| ## Lint | ||
|
|
||
| This project uses [prettier](https://github.com/prettier/prettier) for formatting code and [eslint](https://github.com/eslint/eslint) for other linting. |
docs/tests.md
Outdated
| - fixtures/ | ||
| - fixture-name/ | ||
| - actual.js # source | ||
| - expected.js # minify transforms applied (except whitespace) |
boopathi
force-pushed
the
docs-fixtures-0
branch
from
a559124
to
8c0992e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.