From 56aa2210d8eabd4ca138935b23ca1f9c75d9c768 Mon Sep 17 00:00:00 2001 From: Gleb Koval Date: Mon, 27 Jan 2025 16:00:26 +0000 Subject: [PATCH] docs: add contributing section to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 954e909..b9daa80 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,10 @@ builds your WACC compiler. Currently running 'make' will call `wacc-compiler` in the root directory of the project. If this doesn't work for whatever reason, there are a few different alternatives you can try in the makefile. **Do not use the makefile as you're working, it's for labts/CI!** + +# Contributing + +- All commit messages must follow the [conventional commits spec](https://www.conventionalcommits.org/en/v1.0.0/). + - **This includes merge request titles**. +- All scala code must be formated with `scala format`. +- All scala code must compile without errors OR WARNINGS.