benchmarkstt icon indicating copy to clipboard operation
benchmarkstt copied to clipboard

PEP 8

Open MikeSmithEU opened this issue 6 years ago • 4 comments

For now Python3 PEP8 will be followed, no decision has been made yet to enforce this (we should imho), dissent can be expressed here.

(issue part of #14)

MikeSmithEU avatar Feb 22 '19 15:02 MikeSmithEU

I played about with Azure Pipelines and GitHub branch protection last night and concluded that while it's a little difficult to set up, it is beneficial.

We can set up multiple Azure Pipeline jobs to run tests on different operating systems and a separate job that runs pycodestyle. The tests successfully run on Windows and Mac VMs too, which are currently failing on Travis.

By separating the jobs we can configure GitHub to block merging if the tests fail, but perhaps we wouldn't want to block if linting fails - we would get that level of flexibility if we want.

I'm not saying we should use it - rather it's a possibility. Take a look at my fake PR on my fork of this repo. It's fairly difficult to see the output of pycodestyle, I hope it's possible to expose it better.

ghost avatar Mar 07 '19 11:03 ghost

@danpope-bbc I'm all for this, for me this can be implemented as-is, and we can still tune the pycodestyle settings, block or not-block, etc. later. Would you also keep the current travis configuration (doesn't hurt really, but indeed isn't cross-os), or completely replace it with the new checks?

MikeSmithEU avatar Mar 12 '19 13:03 MikeSmithEU

I think if we use Azure Pipelines, we wouldn't need to use Travis so we could take that configuration out.

ghost avatar Mar 13 '19 11:03 ghost

PEP 8 has become the used standard, todo:

  • [ ] properly document this decision.

MikeSmithEU avatar May 15 '19 08:05 MikeSmithEU