CONTRIBUTING.md

Contributing to resurfaceio-simulator

© 2016-2024 Graylog, Inc.

Coding Conventions

Our code style is whatever IntelliJ IDEA does by default, with the exception of allowing lines up to 130 characters. If you don't use IDEA, that's ok, but your code may get reformatted.

Git Workflow

Initial setup:

git clone git@github.com:resurfaceio/simulator.git resurfaceio-simulator
cd resurfaceio-simulator

Test and package:

mvn package

Committing changes:

git add -A
git commit -m "#123 Updated readme"       (123 is the GitHub issue number)
git pull --rebase                         (avoid merge bubbles)
git push origin master

Check if any newer dependencies are available:

mvn versions:display-dependency-updates

Scan for security vulnerabilities:

trivy fs .

Release Process

Push this new version to CloudSmith:

mvn deploy

Tag release version:

git tag v3.6.(BUILD_NUMBER)
git push origin v3.6.x --tags

Start the next version by incrementing the version number. (located in pom.xml)