aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6847e39..331d51e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -66,7 +66,15 @@ fails, the PDF build will halt.**
cd same
```
-1. **Run a live watch build:**
+2. **Enable git hooks:** To automatically inject required SPDX license headers
+ on newly created `.typ` files:
+
+ ```bash
+ chmod +x .githooks/pre-commit
+ git config core.hooksPath .githooks
+ ```
+
+3. **Run a live watch build:**
```bash
typst watch preamble.typ specification.pdf
@@ -74,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.*
-2. **Perform a clean release compile:**
+4. **Perform a clean release compile:**
```bash
typst compile preamble.typ specification.pdf