Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 1.89 KB

CONTRIBUTING.adoc

File metadata and controls

69 lines (49 loc) · 1.89 KB
Raw

Thank you for considering contribution!

Table of Contents

TL;DR

  1. find issue for the problem

  2. if not found create one

  3. work or wait :)

How to build

We didn’t publish binary yet so you’ll need to build the jar yourself. Here are the steps to do it:

  1. Download sources.

  2. Install JDK 11

  3. Install Maven 3.8.1 or higher.

  4. Run: mvn clean install

Automated local build environment setup with nix

nix + nix-shell

Sets up required JDK and all other software required for building. Does not change any global OS settings. Building environment is local to the project e.g. you’re using JDK11 by default.

Helps if you want to build the project without changing global system JDK/Maven settings.

  1. Install nix: https://nixos.org/guides/install-nix.html

  2. Run:

    cd liferay-db-setup-core
nix-shell
mvn clean install

nix + direnv

Enters local development environment for the project every time you cd into the project directory.

  1. Install nix: https://nixos.org/guides/install-nix.html

  2. Install direnv_nix: https://github.com/nix-community/nix-direnv#with-nix-env

  3. Run:

    cd liferay-db-setup-core
mvn clean install

Detail

In case of missing feature or a bug. Before doing anything else, please check if there is an open issue for the problem you’ve spotted. If not, please create an issue. The issue will be used as a mean of tracking discussion/documentation about the problem even if you’ll fix it yourself.

Please link the issue in commit messages, as an example here is a commit message that references issue #1:

fix broken feature #1

I recommend the very good guide on writing best commit messages.

Code formatting

To ease merging pains please use prettier formatting included in maven project.

To check if your formatting is ok run:

mvn prettier:check

To reformat all the source run:

mvn prettier:write