1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,36 @@ |
1 |
+contribute |
|
2 |
+========== |
|
3 |
+ |
|
4 |
+If you want to contribute you can use pull requests and the issue tracker |
|
5 |
+on our github mirror: |
|
6 |
+ |
|
7 |
+ https://github.com/schokokeksorg/freewvs/ |
|
8 |
+ |
|
9 |
+If you prefer you can also contact us via e-mail: |
|
10 |
+ |
|
11 |
+ https://schokokeks.org/kontakt |
|
12 |
+ |
|
13 |
+coding style |
|
14 |
+============ |
|
15 |
+ |
|
16 |
+Code should conform to the PEP8 coding standard. Furthermore we enable |
|
17 |
+additional rules in pycodestyle and run some other linting tools |
|
18 |
+(pylint, pyflakes, dlint). |
|
19 |
+ |
|
20 |
+The freewvsdb files should be linted JSON as created by json.dumps with |
|
21 |
+2 spaces indenting. |
|
22 |
+ |
|
23 |
+All code and JSON style requirements can be checked by running the unit |
|
24 |
+tests: |
|
25 |
+ |
|
26 |
+``` |
|
27 |
+python -m unittest |
|
28 |
+``` |
|
29 |
+ |
|
30 |
+security |
|
31 |
+======== |
|
32 |
+ |
|
33 |
+Please report security vulnerabilities via e-mail, you can optionally |
|
34 |
+PGP-encrypt them: |
|
35 |
+ |
|
36 |
+ https://schokokeks.org/kontakt |