Skip to content

Commit

Permalink
docs: adding contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosrodlop committed Nov 13, 2023
1 parent 7c00803 commit 394edfa
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 394edfa

Please sign in to comment.