Update 2017-08-17-spamwave.md

[irc/freenode/web-7.0.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d4b729bdcc38f4fb296785440ff653579855122a..a1eb270aa8660d11123d0879be6caa3fecfec059 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -12,29 +12,51 @@
 ## Coding Style
 - Use lowercase filenames
 - Do not use underscores in filenames
+- File extensions:
 
-Take note about the following fileextensions is preferred over their alternatives: `.md`, `.html`, `.jpg`
+  Type     | Extension
+  -------- | ---------
+  Markdown | .md
+  HTML     | .html
+  JPEG     | .jpg
 
-### MARKDOWN - editorial content
-- Use Brittish English
+Take note about the following fileextensions is preferred over their
+alternatives: `.md`, `.html`, `.jpg`
+
+### Editorial content
+- Use British English
+- Abbreviate with caution
+- Avoid contractions
+- Do not use hyphens as em dashes. Em dashes do not have space around them.
+- Avoid jargon
+- Content changes require approval
+  - If you are on freenode staff, you should know where to ask
+  - If not, any staff can relay to the right people as appropriate
 
 ### CSS
 - Four spaces as indentation
 - Opening curly bracket on the same line as the selector
-- One selector per line, if multiple selectors are grouped then commas + newline is used
+- One selector per line, if multiple selectors are grouped then commas +
+  newline is used
 - One space between selector and opening curly brackets
-- Closing curly bracket should be placed on its own line with one empty line after
-- Rules containing only one Declaration can be put on one single line, a space is required after `{` and before `}`
+- Closing curly bracket should be placed on its own line with one empty line
+  after
+- Rules containing only one Declaration can be put on one single line, a space
+  is required after `{` and before `}`
 - Comments
-  - One line comments (`/* ... */`) should have a space after the opening `/*` and a space before the closing `*/`
-  - Multi line comments should have the closing `*/` on an own line,
-    text are allowed on the same row as the opening `/*`.
-    Note that there must be a space after the opening `/*`.
-    One asterix per line, aligned with the ones in the opening and closing `/*` and `*/`, with one space after the asterix
-- Abbrevations are allowed if they are explained in a comment just before their first appearance. Format: `/* <abbrevation> = <expanded abbrevation> [(optional comment)] */
+  - One line comments (`/* ... */`) should have a space after the opening `/*`
+    and a space before the closing `*/`
+  - Multi line comments should have the closing `*/` on an own line, text are
+    allowed on the same row as the opening `/*`.  Note that there must be a
+    space after the opening `/*`.  One asterix per line, aligned with the ones
+    in the opening and closing `/*` and `*/`, with one space after the asterix
+- Abbrevations are allowed if they are explained in a comment just before their
+  first appearance. Format: `/* <abbrevation> = <expanded abbrevation>
+  [(optional comment)] */`
 - All variables should be declared in `:root {}`
 - All custom media should be declared directly after `:root {}`
-- Reuse variables rather than creating new ones, if possible. (this is to keep a condensed palette)
+- Reuse variables rather than creating new ones, if possible. (this is to keep
+  a condensed palette)
 - All colors must be variables, no colors are declared after `:root { }`
 
 This does not apply to third party css such as open sans, font awesome and freenode.css