2019-06-07 08:43:04 +00:00
|
|
|
<!--
|
|
|
|
|
Don't forget!
|
2021-06-23 10:21:19 +00:00
|
|
|
|
|
|
|
|
- Sign your commits and our DCO: https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits
|
|
|
|
|
|
2019-06-07 08:43:04 +00:00
|
|
|
- If the PR adds or changes a behaviour or fixes a bug of an exported API it would need a unit/e2e test.
|
2021-06-23 10:21:19 +00:00
|
|
|
|
2019-06-07 08:43:04 +00:00
|
|
|
- Where possible use only exported APIs for tests to simplify the review and make it as close as possible to an actual library usage.
|
2021-06-23 10:21:19 +00:00
|
|
|
|
2019-06-07 08:43:04 +00:00
|
|
|
- No tests are needed for internal implementation changes.
|
2021-06-23 10:21:19 +00:00
|
|
|
|
2019-06-07 08:43:04 +00:00
|
|
|
- Performance improvements would need a benchmark test to prove it.
|
2021-06-23 10:21:19 +00:00
|
|
|
|
2019-06-07 08:43:04 +00:00
|
|
|
- All exposed objects should have a comment.
|
2021-06-23 10:21:19 +00:00
|
|
|
|
2019-06-07 08:43:04 +00:00
|
|
|
- All comments should start with a capital letter and end with a full stop.
|
2021-06-23 10:21:19 +00:00
|
|
|
-->
|
