Versions Compared

Old Version 5

changes.mady.by.user Tim Donohue

Saved on

compared with

New Version 6

changes.mady.by.user Tim Donohue

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Initially, likely just the master branch, and perhaps just specific modules (e.g. "dspace-spring-rest") on the master branch.
    • Enabling on master branch only may complicate cherry-picking of code changes from other branches (as line numbers, spacing, etc may change when the code is updated to use the latest DSpace Style Guide)
    • However, if we implement this module-by-module (starting with "dspace-spring-rest", the new DSpace 7 REST API), this may temporarily minimize the cherry-pick conflicts while also ensuring any new code meets the new style guidelines.
  • Backporting to other branches (dspace-6_x, dspace-5_x, dspace-4_x) is yet to be determined.
    • Backporting might affect local checkouts/forks of these branches, as a large number of files will change at once. This has the potential to cause local merge conflicts to occur, if an institution has made Java code customizations.

IDE Support

Most major IDEs include plugins that support Checkstyle configurations. The plugin usually let you import an existing "checkstyle.xml" configuration to configure your IDE to use and/or validate against that style. (Please note: we have not tested all these plugins as of yet, so mileage may vary until we test/verify the plugin is usable)

...