Adds an automatic formatted that uses the same formatting rules based on eclipse to format source code files.
Closes #11
This change is a
[ ] Bug fix
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that will change exisiting functionality)
[x] Documentation update
Description
Add a new plugin to automatically format code by running the formatter:format command. Also bound to the format goal of the compile lifecycle phase.
Add new .hooks directory to allow for automatic code formatting before commiting to ensure that status checks don't failed when trying to make a PR.
Update Readme with hooks instructions.
Motivation/Links
This will ensure that developers with different styles don't have different styles in the codebases. It also makes the git diffs a little easier to track and read.
How was this tested?
Multiple iterations of testing formatting style changes. No actual code or functionality differences.
Todos
[x] Ensure unit tests pass
[x] Update documentation for changes (if necessary)
Overview
Adds an automatic formatted that uses the same formatting rules based on eclipse to format source code files. Closes #11
This change is a
Description
formatter:formatcommand. Also bound to theformatgoal of thecompilelifecycle phase..hooksdirectory to allow for automatic code formatting before commiting to ensure that status checks don't failed when trying to make a PR.Motivation/Links
This will ensure that developers with different styles don't have different styles in the codebases. It also makes the git diffs a little easier to track and read.
How was this tested?
Multiple iterations of testing formatting style changes. No actual code or functionality differences.
Todos