Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.21 KB
Raw

How to contribute

General instruction

  1. Fork the project
  2. Checkout the develop branch
  3. Create a branch describing your contribution for instance: git checkout -b feat/myWonderfulFeature
  4. Develop your changes
  5. Check if license headers are up to date by executing: mvn license:format
  6. Generate package to make sure everything is ok by executing: mvn clean package
  7. Commit your changes by following the Angular commit message convention
  8. Submit your work as a pull request to our develop branch by documenting changes

About the release process

This project is available from Maven Central thanks to the Sonatype OSS repository and thus follows its associated recommendations. Thus, make sure to fit with the associated requirements (e.g. gpg key ready, allow to push to OSSRH, local settings.xml correctly set) before to release this project.

After that, a release can be simply done by:

First executing:

$ mvn release:prepare

Then, answering the prompts for versions and tags and finally executing:

$ mvn release:perform