Update CONTRIBUTING.md

lemire · web-flow · commit 6784530b8b54 · 2020-01-27T09:37:55.000-05:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,8 +20,12 @@ In short, most code changes should either bring new features or better performan
 
 Contributors are encouraged to 
 
+- Document their changes. Though we do not enforce a rule regarding code comments, we prefer that non-trivial algorithms and techniques be somewhat documented in the code.
 - Follow as much as possible the existing code style. We do not enforce a specific code style, but we prefer consistency.
-- Modify as few lines of code as possible when working on an issue. The more lines to you modify, the harder it is for your fellow human beings to understand what is going on.
+- Modify as few lines of code as possible when working on an issue. The more lines you modify, the harder it is for your fellow human beings to understand what is going on.
+- Tools may report "problems" with the code, but we never delegate programming to tools: if there is a problem with the code, we need to understand it. Thus we will not "fix" code merely to please a static analyzer if we do not understand.
+- Provide tests for any new feature. We will not merge a new feature without tests.
+
 
 
 Though we do not have a formal code of conduct, we will not tolerate bullying, bigotery or intimidation. Everyone is welcome to contribute.
