Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit 3296e8f

Browse files
author
Daniel Brook-Roberge
committed
Add a note about ESLint usage to the ES5 README. Add a deprecation warning to the Javascript README.
1 parent 56d37ca commit 3296e8f

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

es5/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1+
# Linting
2+
3+
This folder includes a default ESLint configuration, `mobify-es5.yml`, compatible with ESLint 2.x and 3.x. Many of the formatting issues identified by ESLint can be fixed automatically with `eslint <source-files> --fix`.
4+
15
# General
6+
27
##Comments
38

49
Please comment code extensively. More comments are always better than fewer comments. Comments should describe the why of your code - not what the code is doing:

javascript/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# DEPRECATION WARNING
2+
3+
**The contents of this directory are only applicable to ES5 linting
4+
with ESLint 1.x or lower.**
5+
6+
**For new projects or ESLint 2.x and up, use the contents of the `mobify-code-style/es5` directory**
7+
18
# General
29
##Comments
310

0 commit comments

Comments
 (0)