Document Project Style
As discussed on !159 (merged), there are a couple peculiar rules we obey in this project that might not be entirely obvious to a new contributer, e.g.,
- Only import modules
- One import per line
- Imports should be sorted and grouped (checks provided by flake8-import-order)
- Docstrings (checks provided by flake8-docstrings/pydocstyle)
- etc.
It would be nice to use tools that could enforce this (e.g., OpenStack's Hacking, but that is incredibly slow and has assumptions that all dependencies of the project will be installed which makes using tox even slower).
We should document these in a HACKING
file.