pub-solar-os/doc/CONTRIBUTING.md
teutat3s 1c015508e1
tree: remove bud and all mentions of it
Include upstream update doc updates
2022-08-14 17:16:54 +02:00

14 lines
724 B
Markdown

# TL;DR;
- **Target Branch**: `main`
- **Merge Policy**: green check: merge away. yellow circle: have patience. red x: try again.
- **Docs**: every change set is expected to contain doc updates
- **Commit Msg**: be a poet! Comprehensive and explanatory commit messages
should cover the motivation and use case in an easily understandable manner
even when read after a few months.
- **Test Driven Development**: please default to test driven development you can
make use of the `./examples` & `./e2e` and wire test up in the devshell.
### Within the Devshell (`nix develop`)
- **Hooks**: please `git commit` within the devshell
- **Fail Early**: please run `check-all` from within the devshell on your local machine