aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDenis Chevalier <perso@denischevalier.fr>2026-08-11 11:46:52 +0200
committerDenis Chevalier <perso@denischevalier.fr>2026-08-11 11:46:52 +0200
commit9d5f5ea719d83c0dfe3c3b36194fa39d949230c4 (patch)
tree4c1f3b3454d2c25515d3bf46944ff37612fa680d /CONTRIBUTING.md
parentd0fe7324370d4826df80f4b691288da317e3c5e7 (diff)
downloadsame-main.tar.gz
same-main.tar.bz2
same-main.zip
fix CONTRIBUTING.mdHEADmain
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 331d51e..641bd1b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -44,7 +44,7 @@ $
V_("noise","excess") & approx qty(5, "V") times 10^(-15/20) times sqrt(20000) dot 10^-6 \
V_("noise","excess") & approx qty(5, "V") times 0.1778 times num("141.4e-6") approx qty(125.74, "uV")
$
-``````
+```
If you modify a foundational parameter (e.g. system bandwidth or reference
voltages), Typst must re-evaluate all downstream derivations. **If any assertion
@@ -66,7 +66,7 @@ fails, the PDF build will halt.**
cd same
```
-2. **Enable git hooks:** To automatically inject required SPDX license headers
+1. **Enable git hooks:** To automatically inject required SPDX license headers
on newly created `.typ` files:
```bash
@@ -74,7 +74,7 @@ fails, the PDF build will halt.**
git config core.hooksPath .githooks
```
-3. **Run a live watch build:**
+1. **Run a live watch build:**
```bash
typst watch preamble.typ specification.pdf
@@ -82,7 +82,7 @@ fails, the PDF build will halt.**
*If your edits break an assertion metrology check anywhere in the 90+ pages,
Typst will throw an immediate compiler error in your terminal.*
-4. **Perform a clean release compile:**
+2. **Perform a clean release compile:**
```bash
typst compile preamble.typ specification.pdf