diff options
| author | Matthew Holt <[email protected]> | 2017-04-25 11:05:20 -0600 |
|---|---|---|
| committer | Matthew Holt <[email protected]> | 2017-04-25 11:05:20 -0600 |
| commit | b18527285ddd3d2f692d0cd948ec630774d34374 (patch) | |
| tree | 6fbb524e7c12f897a06b26fe92f3feb40abb5b45 | |
| parent | 1deb99c75cddcc41a3a81b3e2224ef49c5e461f7 (diff) | |
| download | caddy-b18527285ddd3d2f692d0cd948ec630774d34374.tar.gz caddy-b18527285ddd3d2f692d0cd948ec630774d34374.zip | |
Optimizations should be benchmarked or profiled.
| -rw-r--r-- | .github/CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index df32249a3..4ef0c1671 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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. |