From f83c1041d732d02bd10c9db176aa2ff0700a3bb9 Mon Sep 17 00:00:00 2001 From: Geoffrey Ragot Date: Thu, 3 Oct 2024 14:17:05 +0200 Subject: [PATCH] feat: add some doc --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b424f5b5..4b561de9d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,10 @@ # Contributing +The project use [Go standard layout](https://github.com/golang-standards/project-layout), please respect it. +Also, the project use [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) style for commits. + +Development commands involve the usage of [Earthly](https://earthly.dev/) as well as docker for end-to-end testing. + ## Getting started You can test the ledger using the provided docker-compose: