Skip to content

Latest commit

 

History

History
54 lines (46 loc) · 2.02 KB

README.md

File metadata and controls

54 lines (46 loc) · 2.02 KB

Developers guide

Git

The First Thing to Do After You Clone the Project

Before starting the development, please, run the init script. This script initializes your local repository configurations with properties used on the project:

bash git/init.sh

It will set up all git hooks and configure git preferences such as newline symbol conversions and git other attributes. It will also set up a commit message template that if you commit from the console without -m | --message option will provide you with guidelines and quick reference on the message style guide.

Git commit message style guide

Please, see a separate file for this part of the documentation - Git commit message style guide.

IDE

The only integrated development environment that is compatible with dotty at the moment is vs-code. You can install it from the official page Visual Studio Code.

Note: set up the ability to run vs-code from a terminal because it is required for the first run of sbt.

Once vs-code is installed you can open the project in IDE running the following command from the root directory of the project:

sbt launchIDE

You can find more details on the official page Dotty IDE support.

Build Tool

sbt is used as a build tool on the project to jump into an sbt console you could simply run sbt in the root of the project. Run tasks to see list of the available tasks.