Page History

...

Make sure to run all tests when you complete your change to avoid any regression

1. test java code - mvn clean install
2. test .Net code -
   1. at root folder: >mvn clean
   2. >cd lang\cs
   3. >msbuild
   4. >vstest.console.exe Org.Apache.REEF.Tests.dll /Platform:x64
3. Alternatively, open OrgApacheREEFsln in VS, rebuild entire solution, then run all tests in Test explore

. For instructions, see Java build instructions and C# build instructions.

4. Merge the master branch into your branch

...

There are several code quality checks executed as part of the build.

...

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

$ mvn apache-rat:check

...

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

$ 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.

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. You might want to edit pom.xml to have failOnError set to false, so that you get report on all projects at once. A convenient way to run Findbugs is to use the Powershell function:

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
}

If any of them fails, you can re-run it manually to clarify where the violation is. Java build instructions have instructions for running checks separately.

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

...