Browse Source

Add contributing info to README.

master
Chris Smith 5 years ago
parent
commit
31a789fe52
1 changed files with 10 additions and 0 deletions
  1. 10
    0
      README.md

+ 10
- 0
README.md View File

@@ -64,3 +64,13 @@ Environment variable | Description
64 64
 
65 65
 LaS can send messages to a ReportBot instance (sending plain text over a TCP
66 66
 connection with a specified prefix).
67
+
68
+## Contributing
69
+
70
+All code is formatted using [Black](https://github.com/ambv/black) with
71
+default settings. There is a [pre-commit](https://pre-commit.com/)
72
+config file to enable automatic black formatting on commit; to enable
73
+it simply:
74
+
75
+    pip install pre-commit
76
+    pre-commit install

Loading…
Cancel
Save