Skip to content

Commit 521039c

Browse files
committed
update readme, add contributing
1 parent 85512de commit 521039c

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributing
2+
3+
Thanks for contributing!
4+
5+
If you're about to report an issue - please first check if it's already been reported in the [issues page](https://github.com/babel/babel-eslint/issues).
6+
7+
Also check to see if the latest versions of eslint/babel-eslint still produce the issue.
8+
9+
Also check out the [Known Issues](https://github.com/babel/babel-eslint#known-issues) section of the README.
10+
11+
If you are having issues with JSX you might want to check out eslint-plugin-react. If there's an issue with new experimental syntax you might need to report that in eslint-plugin-babel instead.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
1010
For questions and support please visit the [`#linting`](https://babeljs.slack.com/messages/linting/) babel slack channel (sign up [here](https://babel-slack.herokuapp.com))!
1111

12+
> Note that the `ecmaFeatures` config property may still be required for ESLint to work properly with features not in ECMAScript 5 by default. Examples are `globalReturn` and `modules`)
13+
1214
## Known Issues
1315
Flow:
1416
- `no-undef` for global flow types: `ReactElement`, `ReactClass` [#130](https://github.com/babel/babel-eslint/issues/130#issuecomment-111215076)
@@ -21,7 +23,7 @@ Modules/strict mode
2123
Please check out [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react) for React/JSX issues
2224
- `no-unused-vars` with jsx
2325

24-
Please check out [eslint-plugin-babel](https://github.com/babel/eslint-plugin-babel) for other issues such as:
26+
Please check out [eslint-plugin-babel](https://github.com/babel/eslint-plugin-babel) for other issues such as (and more):
2527
- `generator-star` with async/await functions [#78](https://github.com/babel/babel-eslint/issues/78)
2628
- `object-shorthand` with spread operator [#131](https://github.com/babel/babel-eslint/issues/131)
2729

0 commit comments

Comments
 (0)