From d33c8ad1556ab52a71e73f1e2a78e19555832336 Mon Sep 17 00:00:00 2001 From: Mauro Morales Date: Wed, 19 Jun 2024 13:51:50 +0200 Subject: [PATCH] Add coding standards section on contributing.md Signed-off-by: Mauro Morales --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 417071591..3cc352881 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -161,4 +161,12 @@ down issues. Pull request requirements ------------------------- +### Coding standard + +Our pipeline will run some linting to ensure your code additions meet the project standards. If you encounter any issues, please address them before asking for a review from the team. This applies to Go, Yaml and Dockerfile or any newer ones added in the future. + +When it comes to code, Kairos components use the Go programming language. In addition to the linting, do your best to write [Effective Go](https://go.dev/doc/effective_go) code. This is the standard that the core team tries to adhere to. + +### Testing + All changes in our code, whether new features or bug fixes, must include a test. If you need some help don't hesitate to contact the team through one of our [community channels](https://kairos.io/community/)