about summary refs log tree commit diff
path: root/CONTRIBUTING
diff options
context:
space:
mode:
authorStarfall <us@starfall.systems>2022-02-01 09:57:41 -0600
committerStarfall <us@starfall.systems>2023-12-05 10:01:06 -0600
commitf02c4f4c72e9a99da91cdd0a87e5e838e9b8744f (patch)
tree0d802990856ecc5f9efd8fe934c3fbdfd7c75672 /CONTRIBUTING
parent2e12dee61f8f03b86dd029875eb8606864f35eb0 (diff)
strike: add CONTRIBUTING
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r--CONTRIBUTING10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..783cecd
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,10 @@
+Patches are accepted via email <us@starfall.systems> or Matrix DM (check https://starfall.systems/contact for the latest information).
+
+If anyone actually contributes, feel free to suggest a license change with the first patch. Check https://git.starfall.systems/www-starfall-systems/tree/COPYING.md for our thoughts - AGPL or MPL is probably fine.
+
+PATCH CHECKLIST
+---------------
+* Code style matches everything else (PEP8 compliance is suggested but not required, feel free to reindent everything with tabs or go to 90-110 character lines as appropriate)
+* Documentation updated to describe new behavior
+* Example case(s) written in sample/blog
+* `./strike.py sample` run and output in sample/html looks as expected (you can use `git diff` to verify nothing except last-modified lines are changed)