From 394edfaa533f5870a2458b7a7900f9dbcfad7967 Mon Sep 17 00:00:00 2001 From: Carlos Rodriguez Lopez Date: Mon, 13 Nov 2023 18:12:21 +0100 Subject: [PATCH] docs: adding contribution guide --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b63336a3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +This document provides guidelines for contributing to the module. + +## Dependencies + +Validate your changes inside the blueprint-agent described in [.Dockerfile](.docker/Dockerfile). It can be run `make dBuildAndRun`. + +## Linting and Formatting + +Many of the files in the repository can be linted or formatted to +maintain a standard of quality. + +When working with the repository for the first time run pre-commit + +Run `pre-commit install` +Run `pre-commit run --all-files` + +## Release Drafter + +This repository uses [Release Drafter](https://github.com/release-drafter/release-drafter) thus it is mandatory to label Pull Ruquest and recommended to use [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716). \ No newline at end of file