CONTRIBUTING.md

Contributing

Building and Running

See the [README.md] and [docs/setup.md] for more details here.

Formatting code

Download the google-java-format tool, and once installed, run

java -jar google-java-format-{version-number}-all-deps.jar -i `find src/main/java/edu/suffolk -name *.java ! -name CodeTableConstants.java ! -name FilingCode.java`

To format all of your files.

(Note: this command might change slightly! If anything unexpected happens, see if the command in the GitHub Action workflow has changed first.)

Linting the code

We use Spotbugs as a java linter. To find linter errors, run this:

mvn spotbugs:spotbugs
mvn spotbugs:gui

The later command will open a GUI to see all of the bugs that it's found.