From 7b910e400e75c8e99ce14238a5a1f840ba4d840e Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Tue, 3 Sep 2024 20:05:50 +0200
Subject: update readme + contributing.md with new git rules

---
 contributing.md | 7 ++++++-
 readme.md       | 2 ++
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/contributing.md b/contributing.md
index f8c7d97..40e1edd 100644
--- a/contributing.md
+++ b/contributing.md
@@ -6,8 +6,13 @@
 
 # Git
 
+- Push as often as possible
+- Development is done on separate branches, these follow a pattern of
+  `name/feature` (i.e. `loek/dll-so-poc` or `jaro/class2`)
+- The master branch is considered stable, and should always contain a
+  working/compiling version of the project
+
 - TODO: tagging / versions
-- TODO: branch stability / gitflow?
 
 # Code style
 
diff --git a/readme.md b/readme.md
index 4893796..144bdc6 100644
--- a/readme.md
+++ b/readme.md
@@ -2,6 +2,8 @@
 
 systems programming in c++ minor engine
 
+please read [contributing.md](./contributing.md)
+
 # TODO
 
 - add mwe/ folder for experiments and proof-of-concept toys
-- 
cgit v1.2.3