Cover line width and Awaitility in contribution guidelines

olim7t · olim7t · commit eb93f7292982 · 2020-07-22T11:15:49.000-07:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -28,6 +28,11 @@ mvn xml-format:xml-format
 The formatter does not enforce a maximum line length, but please try to keep it below 100 characters
 to keep files readable across all mediums (IDE, terminal, Github...).
 
+### Other text files (markdown, etc)
+
+Similarly, enforce a right margin of 100 characters in those files. Editors and IDEs generally have
+a way to configure this (for IDEA, install the "Wrap to column" plugin).
+
 ## Coding style -- production code
 
 Do not use static imports. They make things harder to understand when you look at the code 
@@ -213,6 +218,10 @@ Static imports are permitted in a couple of places:
   when(codecRegistry.codecFor(DataTypes.INT)).thenReturn(codec);
   verify(codec).decodePrimitive(any(ByteBuffer.class), eq(ProtocolVersion.DEFAULT));
   ```
+* All Awaitility methods, e.g.:
+  ```java
+  await().until(() -> somethingBecomesTrue());
+  ```
 
 Test methods names use lower snake case, generally start with `should`, and clearly indicate the
 purpose of the test, for example: `should_fail_if_key_already_exists`. If you have trouble coming 
