2019-06-07 01:43:04 -07:00
<!--
2023-11-28 02:52:27 -08:00
Please give your PR a title in the form "area: short description". For example "tsdb: reduce disk usage by 95%"
If your PR is to fix an issue, put "Fixes #issue -number" in the description.
2019-06-07 01:43:04 -07:00
Don't forget!
2021-06-23 03:21:19 -07:00
2023-07-17 05:30:23 -07:00
- Please sign CNCF's Developer Certificate of Origin and sign-off your commits by adding the -s / --signoff flag to `git commit` . See https://github.com/apps/dco for more information.
2021-06-23 03:21:19 -07:00
2019-06-07 01:43:04 -07: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 03:21:19 -07:00
2019-06-07 01:43:04 -07: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 03:21:19 -07:00
2019-06-07 01:43:04 -07:00
- Performance improvements would need a benchmark test to prove it.
2021-06-23 03:21:19 -07:00
2019-06-07 01:43:04 -07:00
- All exposed objects should have a comment.
2021-06-23 03:21:19 -07:00
2019-06-07 01:43:04 -07:00
- All comments should start with a capital letter and end with a full stop.
2021-06-23 03:21:19 -07:00
-->