Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.78 KB

How to contribute

The purpose of this page is to provide you with the minimum valuable information about how to contribute to the project.

How to reach us 🗞

Set up the project ⚙️

  • Have a JDK >= 11 installed (even the bundled one with AS/IJ)
  • Clone the repository
  • Run ./scripts/tuner.sh to set up the local tools used by this repository: this script will perform some environmental checks and help to follow our guidelines (e.g. installing Git hooks)
  • Make sure to install the required IDEA plugins, from the pop-up shown when the project is opened, to have a smoother experience in the IDE

Branch & commits convention 📙

We have decided to use the Conventional Commits, this means that there is a specific naming convention for branch and about how to write the commits message.

For instance if you are working on a new feature the branch name must have the feat/ prefix and then a reference about the feature:

feat/1-add-profile-section

The same thing for the commit message:

git commit -m "feat(profile): implement profile section"

Note: code reviews are mandatory, if you are pushing your contribution, you must create a pull request.

Lint & Static code analysis 🎨

We love to keep our code clean and consistent, so we have decided to integrate a plugin which validates it. The detekt configuration is available here.

Note: if you have run ./scripts/tuner.sh, all these checks are executed on pre-commit.