1139894 - Docs: Add flake8 instructions to read the docs

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P3)

Description

[Ed Morley [:emorley]]

Now that bug 1107523 means that flake8 runs as part of the travis run, we should:
1) Mention that code must pass flake8 in the docs
2) Mention how to install (|pip install flake8| or just install the dev.txt requirements)
3) Mention how to run (|flake8| or if you want to see more context, |flake8 --show-source|)
4) Mention how to set up the git commit hook locally, to catch failures before pushing.

Comment 1

[Ed Morley [:emorley]]

Attachment: flake8 improvements

Fixes this bug and also bug 1143086.

Comment 2

[Mauro Doglio [:mdoglio]]

Comment on attachment 8577530 [details] [review]
flake8 improvements

I don't see any commit related to 4), are you planning to include it in a separate patch?

Comment 3

[Ed Morley [:emorley]]

(In reply to Mauro Doglio [:mdoglio] from comment #2)
> I don't see any commit related to 4), are you planning to include it in a
> separate patch?

I still need to figure it out myself and will add it later, I just wanted to avoid annoying everyone else with lack of flake8 instructions in the meantime :-)

Comment 4

[Mauro Doglio [:mdoglio]]

Comment on attachment 8577530 [details] [review]
flake8 improvements

Then this is a r+!

Comment 5

[Treeherder GitHub Bugbot]

Commits pushed to master at https://github.com/mozilla/treeherder-service

https://github.com/mozilla/treeherder-service/commit/30d6576b43580e8bc83244866e046481dfb0b266
Bug 1139894 - Add flake8 to runtests.sh

flake8 is run on Travis, so let's make it harder to forget to run
locally for people who use runtests.sh. Eventually we should move all of
this to setup.py.

https://github.com/mozilla/treeherder-service/commit/213eb3a6a3b81a7cfed6a3f91d407dbf722c46a3
Bug 1139894 - Docs: Move the "Running the tests" section to common tasks

At some point in the future, we may break the "Running the tests"
section out to its own file, but for now "Common Tasks" seems like a
better home than the installation instructions.

https://github.com/mozilla/treeherder-service/commit/34419d9f35f0d308e8c80888bc2fd4b5f7ebca85
Bug 1139894 - Docs: Add instructions for how to run flake8