os/doc/CONTRIBUTING.md

16 lines
724 B
Markdown
Raw Normal View History

# TL;DR;
2023-01-28 20:49:10 +00:00
- **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
2023-01-28 20:49:10 +00:00
- **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
2023-01-28 20:49:10 +00:00
make use of the `./examples` & `./e2e` and wire test up in the devshell.
2021-02-15 00:41:15 +00:00
### Within the Devshell (`nix develop`)
2023-01-28 20:49:10 +00:00
- **Hooks**: please `git commit` within the devshell
- **Fail Early**: please run `check-all` from within the devshell on your local machine