Skip to content

Commit 46c5a47

Browse files
committed
clarify issues, move higher up in readme
1 parent b658808 commit 46c5a47

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,20 @@
44

55
> Also check out the fantastic [babel-eslint](https://github.com/babel/babel-eslint) to lint using [ESLint](https://github.com/eslint/eslint).
66
7-
**NOTE:** Please note that this is experimental and may have numerous bugs. It has been run against `ember.js` and `babel-core` with no errors (at the moment). If there's an issue, first check if you can reproduce with the regular parser (esprima) and the latest version.
7+
**NOTE:** Please note that this is experimental and may have numerous bugs. It has been run against `ember.js` and `babel-core` with no errors (at the moment).
88

99
### Known Issues
1010
- `validateQuoteMarks`
1111

12+
### Issues
13+
> If there's an issue, first check if you can reproduce with the regular parser (esprima) and the latest version of jscs and babel-jscs.
14+
15+
Include: `jscs` and `babel-jscs` version, code snippet/screenshot
16+
17+
- See if the issue is a duplicate.
18+
- Check if the issue is reproducible with regular jscs.
19+
- Run jscs in `--verbose` mode to get the rule name(s) that have issues.
20+
1221
## How does it work?
1322

1423
JSCS allows custom parsers. This is great but some of the syntax nodes that Babel supports
@@ -46,13 +55,5 @@ Check out the [JSCS docs](http://jscs.info/rules.html) for all possible rules.
4655
$ jscs your-files-here
4756
```
4857

49-
### Issues
50-
Include: `jscs` and `babel-jscs` version, code snippet/screenshot
51-
52-
- See if the issue is a duplicate.
53-
- Check if the issue is reproducible with regular jscs.
54-
- Run jscs in `--verbose` mode to get the rule name(s) that have issues.
55-
56-
5758
[travis-url]: https://travis-ci.org/jscs-dev/babel-jscs
5859
[travis-image]: https://travis-ci.org/jscs-dev/babel-jscs.svg?branch=master

0 commit comments

Comments
 (0)