Add CONTRIBUTING.md

open-contracting-archive · Oct 21, 2019 · 4fe1371 · 4fe1371
1 parent 31d485a
commit 4fe1371
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# Contributing
+
+## Developer notes
+
+All reading and writing to disk should be done through the `DataFile` class in `default/data_file.py`. This makes it easier for developers to control and review how user-submitted data is managed, in particular with respect to security issues and disk usage.
+
+## Maintainer notes
+
+* To find instances of writing to disk outside the `DataFile` class, grep for `'w`
+* To find instances of reading from disk outside the `DataFile` class, grep for `open\(`