aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8811a65..27a658d 100644
--- a/README.md
+++ b/README.md
@@ -44,3 +44,20 @@ This list is ever growing, if you want to ask for a package to be prioritized, j
> The cadaver package is available on slackbuilds.org but it's for an older version. I've reported here the script and built the newest version. The slackbuild includes now a pull from the [notroj/neon](https://github.com/notroj/neon) repository which is usually not allowed for SlackBuilds that are uploaded to slackbuilds.org
>
> The Powershell package is available on slackbuilds.org without modifications necessary so I removed it.
+
+## Git Hooks
+
+This repo ships maintainer git hooks under `.extras/hooks/`. After cloning,
+install them with:
+
+```bash
+cp .extras/hooks/* .git/hooks/ && chmod 0755 .git/hooks/{pre,post}-commit
+```
+
+- **pre-commit** lints each changed package with `sbolint` and blocks the
+ commit on errors. It also refuses staged source archives (these are fetched
+ with `sbodl`, never committed). Bypass linting with `SBOLINT=no git commit`.
+- **post-commit** offers to build an SBo submission tarball
+ (`SBo/<package>.tar.gz`) for any added or updated package. To answer the
+ prompt non-interactively, set `SBO_ARCHIVE=yes` or `SBO_ARCHIVE=no` in the
+ environment.