[tl;dr:]
- We are inconsistent with our own established style rules.
- We should become not that.
- How do we coordinate becoming better?
- Do you have any other areas where we can become more spotless?

----------
Hello, devs.

  There are a great many instances throughout the geode codebase that are
in direct contention with our documented style guide [1].  These strike me
as glaring broken windows, but thankfully fixing some of these issues is a
very low-hanging fruit (the mixing of metaphors notwithstanding).

  I've explored some updates to spotlessApply can that correct some of
these issues.  These changes can be seen on my repo, linked below ([2]).  I
have covered the following:
- adherence to the import ordering given in
/etc/eclipseOrganizeImports.importorder
- adherence to modifier ordering, as given in our adoption of the Google
Style Guide ([3])
- removal of dead code in the form of commented-out import statements.

  If anyone has any insight on how to improve spotless beyond this, we
should coordinate to minimize impact on the git log.  Also, I suspect we
will want to coordinate these changes with a release cycle, for greater
clarity in each individual file history.

  What do you think?

Imagination is Change.
~Patrick

---
[1] https://cwiki.apache.org/confluence/display/GEODE/Code+Style+Guide
[2] https://github.com/PurelyApplied/geode/blob/spotless/build.gradle
[3] https://google.github.io/styleguide/javaguide.html#s4.8.7-modifiers

---
Impact of corrections made by these changes to spotless, as rebased against
2017-08-23's commit 039edfc...

-- 2,525 files with incorrect import ordering corrected.
-- 115 pointless lines of commented-out import statements removed.
-- 1,988 lines across 480 files with incorrect modifier ordering corrected

Reply via email to