Skip to content

Commit b828b65

Browse files
Add 'make flake8' step and docs on code quality
1 parent a5cc3a0 commit b828b65

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ install: bin/mongodb-consistent-backup
2222
install -m 0644 LICENSE $(SHAREDIR)/$(NAME)/LICENSE
2323
install -m 0644 README.rst $(SHAREDIR)/$(NAME)/README.rst
2424

25+
flake8:
26+
# Ignore long-lines and space-aligned = and : for now
27+
flake8 --ignore E221,E241,E501 $(PWD)/$(NAME)
28+
2529
uninstall:
2630
rm -f $(BINDIR)/mongodb-consistent-backup
2731
rm -rf $(SHAREDIR)/$(NAME)

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,12 @@ Roadmap
218218
- Documentation for running under Docker with persistent volumes
219219
- Python unit tests
220220

221+
Submitting Code
222+
~~~~~~~~~~~~~~~
223+
224+
- Submitted code must pass Python `'flake8' <https://pypi.python.org/pypi/flake8>`__ checks. Run *'make flake8'* to test.
225+
- To make review easier pull requests must address and solve a one problem at a time.
226+
221227
Links
222228
~~~~~
223229

0 commit comments

Comments
 (0)