2021-02-15 00:41:15 +00:00
|
|
|
# Pull Requests
|
2021-06-03 19:25:06 +00:00
|
|
|
|
2021-08-01 21:38:52 +00:00
|
|
|
## TL;DR;
|
|
|
|
|
- **Target Branch**: `main`
|
|
|
|
|
- **Merge Policy**: [`bors`][bors] is alwyas right (→ `bors try`)
|
|
|
|
|
- **Docs**: every changeset 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 where possible.
|
2021-02-15 00:41:15 +00:00
|
|
|
|
2021-08-01 21:38:52 +00:00
|
|
|
### Within the Devshell (`nix develop`)
|
|
|
|
|
- **Hooks**: please `git commit` within the devshell
|
|
|
|
|
- **Fail Early**: please run from within the devshell on your local machine:
|
|
|
|
|
- `nix flake check`
|
2021-02-15 00:41:15 +00:00
|
|
|
|
2021-08-01 21:38:52 +00:00
|
|
|
[bors]: https://bors.tech
|
2021-02-15 00:41:15 +00:00
|
|
|
|
