2022-08-13 19:34:46 +00:00
|
|
|
# TL;DR;
|
2023-01-28 20:49:10 +00:00
|
|
|
|
2021-10-11 22:32:01 +00:00
|
|
|
- **Target Branch**: `main`
|
2022-08-13 19:34:46 +00:00
|
|
|
- **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
|
2021-08-01 21:38:52 +00:00
|
|
|
should cover the motivation and use case in an easily understandable manner
|
|
|
|
|
even when read after a few months.
|
2022-08-13 19:34:46 +00:00
|
|
|
- **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
|
|
|
|
2021-08-01 21:38:52 +00:00
|
|
|
### Within the Devshell (`nix develop`)
|
2023-01-28 20:49:10 +00:00
|
|
|
|
2021-08-01 21:38:52 +00:00
|
|
|
- **Hooks**: please `git commit` within the devshell
|
2022-08-13 19:34:46 +00:00
|
|
|
- **Fail Early**: please run `check-all` from within the devshell on your local machine
|
