Create (and enforce) a TARDIS code style guide

[harpolea]

There should be a section of the documentation which describes TARDIS' code style conventions. This will help the code's readability and assist new contributors. The guide could cover

• adherence to PEP 8
• function and variable names
• docstrings

To enforce this, it would be helpful to automatically run a linter (e.g. flake8) on PRs which prints out any infringements of PEP 8 it finds. (Note some of PEP 8's suggestions are not always useful, so I suggest creating a .flake8 file to list files and style conventions we'd like it to ignore)

[harpolea]

This will address #1094

[jaladh-singhal]

@harpolea I think autopep8 can be helpful (I came to know about when making PR on astroquery)?

Apparently, it also provides option of configuring with .flake8 as you mentioned!

[harpolea]

Yeah, there are several style linters around (black is another popular one) - I mainly suggested flake8 as that’s the one I normally use, but they all pretty much do the same thing.

[arjunsavel]

Another thing that might be helpful is isort — just in the way of making things more automated.

[harpolea]

One way to do this would be to use a precommit hook: yt-project/yt#2600

[jaladh-singhal]

Code style guide has been "create"ed in #1405 but we still need to work on "enforce"ing it by creating a black pre-commit hook!

[jaladh-singhal]

we still need to work on "enforce"ing it

It's made possible by #1398, new PRs can't be merged unless code is formatted by black