chore: add some docs

This commit is contained in:
andig 2022-11-05 17:35:25 +01:00
parent 3862fcb85a
commit 6d7a79e6f9
2 changed files with 23 additions and 0 deletions

15
docs/releng.md Normal file
View file

@ -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

8
docs/status.md Normal file
View file

@ -0,0 +1,8 @@
# Charger status transition events
From-To|A|B|C
-|-|-|-
None<br>(Startup)|disconnected|connected|connected<br>start charging
A|-|connected|connected<br>start charging
B|disconnected|-|start charging
C|disconnected<br>stop charging|stop charging|-