aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-09-05 08:30:46 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-09-05 08:30:46 +0200
commitce495dfbfd3eaecb84b3c536ad2176a7249d5b19 (patch)
treee2c65feb46c630229f4b0331bc710e760200633f /contributing.md
parentd77a7841f178d50d30fcaed05d1efc79f191d66d (diff)
add some banned practices to contributing.md
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
index ab14b71..770d02e 100644
--- a/contributing.md
+++ b/contributing.md
@@ -15,6 +15,22 @@ other document.
- Images should be placed in the img/ folder
- Labels and bibliography keys should only consist of characters from the
following set: `[a-z0-9:-]` (lower-case, numbers, colon, dash).
+- Quotes are opened with the tilde (<code>`</code>)
+
+# Banned practices
+
+- **Using `\newpage`**
+
+ Widows and orphans are handled by LaTeX. If you want to prevent a page break
+ from occurring between two paragraphs, use the `\noparbreak` command at the
+ end of the first paragraph. For larger chunks, the `\needspace{<length>}`
+ command should be used instead.
+- **Using `\href`**
+
+ Add the source in sources.bib and cite this source instead.
+- **Using `\textbf` or `\textit` to emphasize**
+
+ Use `\emph`, single quotes or an em dash (`---`) instead.
# References