Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add Findbugs instructions

...

Resolve the conflicts if exist. Test with the merged code so that it does not break the system.

There are two several code quality checks executed as part of the build. First, Apache

  1. Apache RAT verifies that Apache headers are in place where needed. You can run this check manually:

    Code Block
    languagetext
    $ mvn apache-rat:check

     

...

  1. Checkstyle verifies that all Java code adheres to a coding standard. If this check fails, you should re-run Checkstyle manually:

    Code Block
    languagetext
    $ mvn checkstyle:checkstyle

     Then read Checkstyle results for the module which fails verification in .\target\site\checkstyle.html. Violations which caused the build break will show up as errors and need to be fixed; violations which show up as warnings or info can be ignored.

  2. Findbugs looks for bugs in Java code, and fails the build if there are any high-priority warnings are found. If this check fails, you should re-run Findbugs manually to get a human-readable report on warnings found. A convenient way to do this is to use the Powershell function:

    Code Block
    languagetext
    function Findbugs{
        Push-Location "$REEFSourcePath"
        Get-ChildItem . -include findbugsXml.html -recurse | foreach ($_) {remove-item $_.fullname}
        Get-ChildItem . -include findbugs-exclude.html -recurse | foreach ($_) {remove-item $_.fullname}
        Invoke-Expression 'mvn findbugs:check'
        Invoke-Expression 'mvn xml:transform'
        Pop-Location
    }

    The reports for each subproject will be located at .\target\findbugs\findbugsXml.html.

Finally, as a courtesy to the merger, you can rebase to master and squash all the commits from your PR into one:

...