Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.25 KB

File metadata and controls

33 lines (25 loc) · 1.25 KB

Contributing Guide

This project is built with Quarkus on Kotlin. If you're unfamiliar with that I suggest you spend 30min to go through its excellent Getting Started tutorial. You will like what you see, I promise.

You have to have JDK 17+ and Maven installed, but if you've come this far, I assume you already know that.

Development environment setup

  • git clone https://github.com/marcelstoer/open-data-smn.git
  • cd open-data-smn/
  • mvn quarkus:dev
  • http://localhost:8080

Commit messages

From: http://git-scm.com/book/ch5-2.html

Short (50 chars or less) summary of changes

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded by a
   single space, with blank lines in between, but conventions vary here