diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3851c420..93144724 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,8 @@ You can run all the test cases by invoking `make test`. Please create a new PR against the `main` branch which must be based on the project's [pull request template](.github/PULL_REQUEST_TEMPLATE.md). +Please follow the [Conventional Commits](https://www.conventionalcommits.org/) specification when naming your commits. + ## Coding conventions We expect that all code contributions have been formatted using `gofmt`. diff --git a/README.md b/README.md index 6e287912..126ad778 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/bpg/terraform-provider-proxmox)](https://github.com/bpg/terraform-provider-proxmox/releases/latest) [![GitHub Release Date](https://img.shields.io/github/release-date/bpg/terraform-provider-proxmox)](https://github.com/bpg/terraform-provider-proxmox/releases/latest) [![GitHub stars](https://img.shields.io/github/stars/bpg/terraform-provider-proxmox)](https://github.com/bpg/terraform-provider-proxmox/stargazers) +[![Conventional Commits](https://img.shields.io/badge/conv%20commits-v1.0.0-ff69b4)](https://www.conventionalcommits.org/en/v1.0.0/#specification) # Terraform Provider for Proxmox A Terraform Provider which adds support for Proxmox solutions.