Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

19 lines (11 loc) · 1.24 KB
Raw

Getting started

To get started, follow instruction from README to install all the tools you will need.

IDE setup

IntelliJ IDEA setup

For IntelliJ, you will need our custom code style. To set it up, download happening-settings.zip file and use Import Settings action in IntelliJ to import it. After that, go to Settings -> Editor -> Code Style and select Happening-Java scheme to set correct code style. Also, go to Settings -> Editor -> Inspections and select Happening-Java scheme to set correct inspections.

VSCode setup

For VSCode, there's already project-specific configuration set up in .vscode folder. For this to work, you will also need Java Language Support extension or you can follow an official guide and install the whole pack suggested by Microsoft.

Other editors and formatting

Since we are using Spotless with Eclipse XML configuration you can simply run mvn spotless:check to verify that the formatting is correct or mvn spotless:apply to fix it.