docs: 📝 add contribution guidelines

titigmr · Aug 3, 2024 · d5ed45c · d5ed45c
1 parent b2886f8
commit d5ed45c
Showing 1 changed file with 16 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -2,19 +2,19 @@
 
 ExternalDNS is a Kubernetes add-on for automatically managing Domain Name System (DNS) records on Kubernetes objects (ingress, crd, services) by using different DNS providers (aws, ovh, webhook...). 
 
-This repository use the [webhook provider](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/webhook-provider.md). This webhook is a sidecar running in the same pod as external-dns, which manage MiDaas dns records . 
+This repository use the [webhook provider](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/webhook-provider.md). This webhook is a sidecar running in the same pod as external-dns, which manage MiDaas dns records. 
 
 To use ExternalDNS with MiDaas, you need to inject TSIG on each zone you want to manage.
 
 ## Kubernetes deployment
 
 You can deploy the webhook using the following commands:
 
-```
+```sh
 helm repo add external-dns https://kubernetes-sigs.github.io/external-dns/
 ```
 
-1. Create the helm values file `external-dns-midaas-values.yaml`
+1. Create the helm values file `external-dns-midaas-values.yaml`:
 
 ```yaml
 # if midaas can delete records in dns zone
@@ -37,8 +37,18 @@ provider:
     value: https://midaas.com/midaas/ws"
 ```
 
-2. Create helm deployment
+2. Create helm deployment:
+
+```sh
+helm install external-dns external-dns -f external-dns-midaas-values.yaml
+```
+
+## Local development
+
+🚧 Work in progress.
+
+## Contributions
 
-`helm install external-dns external-dns -f external-dns-midaas-values.yaml`
+Commits must follow the specification of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), it is possible to add the [VSCode extension](https://github.com/vivaxy/vscode-conventional-commits) to facilitate the creation of commits.
 
-## Local development
+A PR must be made with an updated branch with the `main` branch in rebase (and without merge) before requesting a merge, and the merge must be requested in `main`.