aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0e673bc..4427878 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,20 @@ and also requires some manual work on your part for best results.
Documentation is included at the top of `import_issues.py`. Please read that
before running an import.
+## Contributing
+
+Patches, suggestions, etc. are welcome at:
+https://lists.sr.ht/~khumba/public-inbox
+
+The Python code here is formatted with [Black](https://pypi.org/project/black/).
+Please add the following to your Git pre-commit hook, to verify that the file is
+properly formatted before committing. Create `.git/hooks/pre-commit` with the
+following contents, and mark the file as executable with `chmod +x`:
+
+ #!/bin/sh
+
+ black --check import_issues.py
+
## License
Copyright 2024 Bryan Gardiner <bog@khumba.net>