summaryrefslogtreecommitdiffstats
path: root/SUBMITTING_PATCHES.md
diff options
context:
space:
mode:
Diffstat (limited to 'SUBMITTING_PATCHES.md')
-rw-r--r--SUBMITTING_PATCHES.md26
1 files changed, 20 insertions, 6 deletions
diff --git a/SUBMITTING_PATCHES.md b/SUBMITTING_PATCHES.md
index 07f76616..e8a72e87 100644
--- a/SUBMITTING_PATCHES.md
+++ b/SUBMITTING_PATCHES.md
@@ -1,3 +1,5 @@
1[TOC]
2
1# Short Version 3# Short Version
2 4
3 - Make small logical changes. 5 - Make small logical changes.
@@ -52,17 +54,29 @@ Run `flake8` on changes modules:
52 54
53 flake8 file.py 55 flake8 file.py
54 56
55Note that repo generally follows [Google's python style guide] 57Note that repo generally follows [Google's python style guide] rather than
56(https://google.github.io/styleguide/pyguide.html) rather than [PEP 8] 58[PEP 8], so it's possible that the output of `flake8` will be quite noisy.
57(https://www.python.org/dev/peps/pep-0008/), so it's possible that 59It's not mandatory to avoid all warnings, but at least the maximum line
58the output of `flake8` will be quite noisy. It's not mandatory to 60length should be followed.
59avoid all warnings, but at least the maximum line length should be
60followed.
61 61
62If there are many occurrences of the same warning that cannot be 62If there are many occurrences of the same warning that cannot be
63avoided without going against the Google style guide, these may be 63avoided without going against the Google style guide, these may be
64suppressed in the included `.flake8` file. 64suppressed in the included `.flake8` file.
65 65
66[Google's python style guide]: https://google.github.io/styleguide/pyguide.html
67[PEP 8]: https://www.python.org/dev/peps/pep-0008/
68
69
70## Running tests
71
72There is a [`./run_tests`](./run_tests) helper script for quickly invoking all
73of our unittests. The coverage isn't great currently, but it should still be
74run for all commits.
75
76Adding more unittests for changes you make would be greatly appreciated :).
77Check out the [tests/](./tests/) subdirectory for more details.
78
79
66## Check the license 80## Check the license
67 81
68repo is licensed under the Apache License, 2.0. 82repo is licensed under the Apache License, 2.0.