aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-09-03 20:05:50 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-09-03 20:05:50 +0200
commit7b910e400e75c8e99ce14238a5a1f840ba4d840e (patch)
tree8dddf1a81ac6eeb837ac7c1176f06b69c938ddb2
parent9f33af98ac570e1ee0945852c38b8081f55cfa76 (diff)
update readme + contributing.md with new git rules
-rw-r--r--contributing.md7
-rw-r--r--readme.md2
2 files changed, 8 insertions, 1 deletions
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