Skip to content

Commit

Permalink
update save action guide (#1962)
Browse files Browse the repository at this point in the history
See #1920
  • Loading branch information
burgerkingeater committed Oct 12, 2018
1 parent d7a8ba4 commit db6d31a
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions CONTRIBUTING.md
Expand Up @@ -53,20 +53,21 @@ Install and enable the intellij's
[save actions plugin](https://github.com/dubreuia/intellij-plugin-save-actions)
to reformat/refactor code automatically:

Please turn on all the options except
* Remove unused suppress warning annotation

It allows us to do following when saving a file:
* Organize imports
* Reformat code based on the code style
* Rearrange code (reorder methods, fields, etc.)
* Add final to local variable
* Add final to field
* Remove explicit generic type for diamond
* Qualify field access with this
* Remove final from private method
* Remove unnecessary semicolon
* Add missing @Override annotations
Please turn on the following options only (all of them are available in release 1.1.0 and above, see https://github.com/dubreuia/intellij-plugin-save-actions/releases):
* Optimize imports
* Reformat file
* Add final modifier to field
* Add final modifier to local variable or parameter
* Add this to field access
* Add class qualifier to static member access outside declaring class only
* Add missing @Override annotations
* Add blocks to if/while/for statements
* Add missing serialVersionUID field for Serializable classes
* Remove final from private method
* Remove explicit generic type for diamond
* Remove unnecessary semicolon

Please refer to save actions plugin (https://github.com/dubreuia/intellij-plugin-save-actions) for implication of each option.

### New line at the end of a file

Expand Down

0 comments on commit db6d31a

Please sign in to comment.