notes on documentation and trailing commas

This commit is contained in:
Dan Wolff 2018-02-05 23:29:26 +01:00
parent 22f5e085db
commit c63ea2978b

View File

@ -1,6 +1,10 @@
Contributing Contributing
============ ============
## Documentation
Every new feature and API change should be accompanied by a README additon.
## Testing ## Testing
All features and bugs should have tests that verify the fix. You can run all All features and bugs should have tests that verify the fix. You can run all
@ -19,6 +23,7 @@ Tests that cannot be expressed as a simple AST can be found in `test/mocha`.
- Indentation uses 4 spaces, switch `case` 2 spaces. - Indentation uses 4 spaces, switch `case` 2 spaces.
- Identifiers use `snake_case`. - Identifiers use `snake_case`.
- Strings use double quotes (`"`). - Strings use double quotes (`"`).
- Multiline object and array literals use trailing commas.
- The Uglify code only uses ES5, even in the `harmony` branch. - The Uglify code only uses ES5, even in the `harmony` branch.
- Line length should be at most 80 cols, except when it is easier to read a - Line length should be at most 80 cols, except when it is easier to read a
longer line. longer line.