From 0e95b3b375b32bc65de0af6a77137750aef77919 Mon Sep 17 00:00:00 2001
From: sinavir <sinavir@sinavir.fr>
Date: Fri, 23 Feb 2024 17:22:51 +0100
Subject: [PATCH] feat(README): Add guidelines for contributions and doc for
 dev tools

---
 CONTRIBUTE.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 README.md     |  7 ++++++-
 2 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
new file mode 100644
index 0000000..c07e430
--- /dev/null
+++ b/CONTRIBUTE.md
@@ -0,0 +1,42 @@
+# Contribuer
+
+Quelques éléments à savoir:
+- La branche `main` doit normalement suivre l'état des machines en production. Si vous ne déployez pas tout de suite faîtes une branche et une PR.
+- Les commits doivent passer le crochet de `pre-commit` (cf ci-dessous pour savoir comment l'installer)
+
+
+## Shell de développement et crochets `pre-commit`
+
+Le dépot possède un shell de développement:
+```
+nix-shell
+```
+
+Pour installer les crochets, il suffit de lancer le shell de developpement une fois.
+
+
+## Lister les machines
+
+Dans le shell de developpement, exécuter:
+```
+list-nodes
+```
+
+
+## Lancer une vm de test
+
+Dans le shell de developpement, exécuter:
+```
+launch-vm -p MACHINE
+```
+
+On peut faire du port forwarding (pour avoir accès à ssh par exemple) avec l'option `-p HOSTPORT-:GUESTPORT`.
+
+
+## Tester les versions en production
+
+En attendant [https://github.com/RaitoBezarius/mimir](`mimir`), on peut tester localement si c'est bien le dernier commit de main qui est déployé avec:
+```
+nix-shell --run 'check-deployment [NODE_NAME]'
+```
+
diff --git a/README.md b/README.md
index 4a8d0b4..fc956bc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
 # ❄️ infrastructure
 
-The dgnum infrastructure
+The dgnum infrastructure.
+
+# Contributing
+Some instruction on how to contribute are available (in french) in [/CONTRIBUTING.md](CONTRIBUTING.md). You're expected to read this document before commiting to the repo.
+
+Some documentation for the development tools are provided in the aforementioned file.