CONTRIBUTING.md

   1 # Contributor Guide
   2
   3 Thank you so much for improving `reguloj`!
   4 Without a healthy community, any open source project is doomed.
   5
   6 ## Git Branching Model
   7
   8 The `main` branch always contains the latest public stable release.
   9
  10 ## Issue Management
  11
  12 We are using the issue tracker over at [GitHub](https://github.com/metio/reguloj/issues/) to track issues.
  13
  14 ## Building the Project
  15
  16 Execute the following to build the project locally:
  17
  18 ```shell
  19 $ mvn verify
  20 ```
  21
  22 ## Release Process
  23
  24 The release process is highly automated. It checks every week for changes in the `src/main/java` folder and creates a new timestamped release in case there were any changes.