From 6d7a79e6f9746a962f2b5f1af6b4fae5939ae220 Mon Sep 17 00:00:00 2001 From: andig Date: Sat, 5 Nov 2022 17:35:25 +0100 Subject: [PATCH] chore: add some docs --- docs/releng.md | 15 +++++++++++++++ docs/status.md | 8 ++++++++ 2 files changed, 23 insertions(+) create mode 100644 docs/releng.md create mode 100644 docs/status.md diff --git a/docs/releng.md b/docs/releng.md new file mode 100644 index 000000000..ac782c36c --- /dev/null +++ b/docs/releng.md @@ -0,0 +1,15 @@ +# Branching concept + +- `master` is the default branch +- releases `SHOULD` be triggered from `master` branch +- release will trigger when tag is pushed on any branch +- to create bugfix release, branch from `master` and create a tag +- releases `SHOULD` not be created locally as they will conflict with pushing tagged branch + +## Contents + +Release contains: + +- Github +- Docker +- Cloudsmith diff --git a/docs/status.md b/docs/status.md new file mode 100644 index 000000000..3d4250d32 --- /dev/null +++ b/docs/status.md @@ -0,0 +1,8 @@ +# Charger status transition events + +From-To|A|B|C +-|-|-|- +None
(Startup)|disconnected|connected|connected
start charging +A|-|connected|connected
start charging +B|disconnected|-|start charging +C|disconnected
stop charging|stop charging|-