Optimizations should be benchmarked or profiled.

This commit is contained in:
Matthew Holt 2017-04-25 11:05:20 -06:00
parent 1deb99c75c
commit b18527285d
No known key found for this signature in database
GPG Key ID: 2A349DD577D586A5

View File

@ -37,6 +37,8 @@ Here are some of the expectations we have of contributors:
- **Write tests.** Tests are essential! Written properly, they ensure your change works, and that other changes in the future won't break your change. CI checks should pass.
- **Benchmarks should be included for optimizations.** Optimizations sometimes make code harder to read or have changes that are less than obvious. They should be proven to work better with benchmarks or profiling.
- **[Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) insignificant commits.** Every commit should be significant. Commits which merely rewrite a comment or fix a typo can be combined into another commit that has more substance.
- **Own your contributions.** Caddy is a growing project, and it's much better when individual contributors can help maintain their change after it is merged.