Dev Docs: Style Guide

[voetberg]

Additions:

• General style rules (writing out what it's included in the flake8 precommit)
• Rules on imports (isort rules)
• Few words on testing (preference for using fixtures, not writing dirty tests)
• Rough SQLAlchemy style guide. Based mostly on what I've observed, so there may be some mistakes. None of this is written down before so ?? It's rough.
• What's included in the precommit and the github action checks

[rdimaio]

Some minor comments - btw, I think you can click on "commit suggestion" or "add suggestion to batch" directly on GH to apply these, might be faster than manually doing each change (never tried it though so I'm not sure)

[voetberg]

Some minor comments - btw, I think you can click on "commit suggestion" or "add suggestion to batch" directly on GH to apply these, might be faster than manually doing each change (never tried it though so I'm not sure)

Never noticed there was an option to batch them.... Always avoided committing from suggestions like this so I didn't clutter the commit history, but that's a nice feature. You win this one gh.

[rdimaio]

Some minor comments - btw, I think you can click on "commit suggestion" or "add suggestion to batch" directly on GH to apply these, might be faster than manually doing each change (never tried it though so I'm not sure)

Never noticed there was an option to batch them.... Always avoided committing from suggestions like this so I didn't clutter the commit history, but that's a nice feature. You win this one gh.

Yeah, I thought it would be worth doing that and then doing "Squash and merge" when closing the PR, so that we'd end up with a single commit anyway, but it seems that it's not possible for this repo:

@bari12 is there a reason this feature is not available in this repo? It's available for the rucio/rucio repository

Temporarily dismissing approval to see if we can enable "squash and merge" for this repo, so we can end up with a single commit

[dchristidis]

This PR warranted additional discussion. This particular example isn’t even functional!

[rdimaio]

I re-opened #287, we can track follow-up comments on there and address them

[rdimaio]

ignore this: fcdde46 - was just testing what GH did when you press revert on the PR