Skip to content

docs(contributing): move to docs directory [skip ci]#735

Merged
boopathi merged 3 commits intomasterfrom
docs-fixtures-0
Nov 21, 2017
Merged

docs(contributing): move to docs directory [skip ci]#735
boopathi merged 3 commits intomasterfrom
docs-fixtures-0

Conversation

@boopathi
Copy link
Copy Markdown
Member

No description provided.

+ Add docs about fixtures testing
+ Add some getting-started docs
@boopathi boopathi requested a review from hzoo November 19, 2017 22:08
@boopathi boopathi added the Tag: Docs Pull Request updating Documentation label Nov 19, 2017
Comment thread docs/debugging.md
@@ -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.
Copy link
Copy Markdown
Member

@vigneshshanmugam vigneshshanmugam Nov 20, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we extend this and add like
when you use BabelMinify standalone or babel-minify as a preset in babelrc

Comment thread 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).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Babylon is now inside the monorepo.

Comment thread 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).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in order by probability? (2-3-1)

Comment thread docs/tests.md

## Lint

This project uses [prettier](https://github.com/prettier/prettier) for formatting code and [eslint](https://github.com/eslint/eslint) for other linting.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ESLint :)

Comment thread docs/tests.md Outdated
- fixtures/
- fixture-name/
- actual.js # source
- expected.js # minify transforms applied (except whitespace)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and comment removal

@boopathi boopathi merged commit 8c28e1d into master Nov 21, 2017
@boopathi boopathi deleted the docs-fixtures-0 branch November 21, 2017 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tag: Docs Pull Request updating Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants