Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (21 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

37 lines (21 loc) · 1.27 KB

Contributing

Source formatting

Please ensure that you run mvn formatter:format before commit.

It relies on the following configuration file eclipse/formatter-config.xml.

To configure eclipse to use this code formatter, see "Preferences window, go to Java -> Code Style -> Formatter -> Import".

Continuous Integration (CI)

Note that CI is configured throw GitHub Actions.

It relies on .github/workflows/main.yml which :

You may run bash .ci/build-openjdk11.sh to ensure that source code is formatted, build code and run tests.

Create releases

  • Ensure that you are on the right branch and that all code is committed and push (git status)
  • Run mvn release:prepare and follow instructions to automatically create tags and update version in pom.xml files
  • Build JAR and packages for the new tag
git checkout v4.2.5
make package
  • Create release from github tag with the following binary files : validator-cli/target/validator-cli.jar, ign-validator_{VERSION}_all.deb and ign-validator-{VERSION}-1.noarch.rpm