Skip to content

Commit

Permalink
[Docs] Add explanation for code snippets line width (#34796)
Browse files Browse the repository at this point in the history
Add "Line width for code snippets is 76 characters" to  Java Language Formatting Guidelines
  • Loading branch information
wangzhenhui1992 authored and kcm committed Oct 30, 2018
1 parent 9818272 commit e234529
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ Please follow these formatting guidelines:

* Java indent is 4 spaces
* Line width is 140 characters
* Line width for code snippets that are included in the documentation (the ones surrounded by `// tag` and `// end` comments) is 76 characters
* The rest is left to Java coding standards
* Disable “auto-format on save” to prevent unnecessary format changes. This makes reviews much harder as it generates unnecessary formatting changes. If your IDE supports formatting only modified chunks that is fine to do.
* Wildcard imports (`import foo.bar.baz.*`) are forbidden and will cause the build to fail. This can be done automatically by your IDE:
Expand Down

0 comments on commit e234529

Please sign in to comment.