CONTRIBUTING.md

   1 # Contributor Guide
   2
   3 Thanks a lot for contributing to `YoSQL`!
   4
   5 ## Local Setup
   6
   7 In order to build `YoSQL`, you will need Java 16+ and Maven 3.6.3+. Make sure that both are installed on your system and available on your `PATH`.
   8
   9 ```shell
  10 # check java
  11 $ java -version
  12 penjdk version "16" 2021-03-16
  13 OpenJDK Runtime Environment (build 16+36-2231)
  14 OpenJDK 64-Bit Server VM (build 16+36-2231, mixed mode, sharing)
  15
  16 # check javac
  17 $ javac -version
  18 javac 16
  19
  20 # check maven version
  21 $ mvn --version
  22 Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
  23 Maven home: /usr/share/maven
  24 Java version: 16, vendor: Oracle Corporation, runtime: /usr/java/openjdk-16
  25 Default locale: en, platform encoding: UTF-8
  26 OS name: "linux", version: "5.11.10-200.fc33.x86_64", arch: "amd64", family: "unix"
  27 ```
  28
  29 ## Building the project
  30
  31 In order to build the project use the typical Maven goals, e.g.:
  32
  33 ```shell
  34 # build all modules and run all tests
  35 $ mvn verify
  36 ```
  37
  38 **Note**: Each pull request will be build by GitHub and call `mvn verify`. In case you want to reproduce errors locally, run that first and fix any errors that show up.
  39
  40 ## Creating forks or feature branches
  41
  42 In case you want to contribute code, either fork the repository if you are not yet an active contributor or create a git branch for every feature or bugfix you are working on. You can open up a pull request as early as you like, we recommend doing it right after creating your fork and adding a "WIP" prefix to your pull request. You can directly ping contributors with specific questions about existing code and how to implement your idea in the best way possible.
  43
  44 Since `YoSQL` will not have a plugin system by design, we are trying to make contributor changes to the project as easy as possible. In case you encounter any errors, e.g. while building the project, don't hesitate to open a ticket in order to get that fixed first.