aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDenis Chevalier <perso@denischevalier.fr>2026-08-11 01:48:41 +0200
committerDenis Chevalier <perso@denischevalier.fr>2026-08-11 01:48:41 +0200
commit10398290704e99a969aec921bb392af6552b383a (patch)
tree6471935dabf9d9c66ad0b886b5394bab58b2d3de /CONTRIBUTING.md
parentd7621adc4bbbf7f9779f5cf33ee95dbc31d92ecd (diff)
downloadsame-10398290704e99a969aec921bb392af6552b383a.tar.gz
same-10398290704e99a969aec921bb392af6552b383a.tar.bz2
same-10398290704e99a969aec921bb392af6552b383a.zip
typo in README.md, add git hook for new typ files SPDX header
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