Onboarding for new developers

[mcocdawc]

Here I would like to collect information for onboarding new developers.

• PEP8
• ruff
• git-hook
• git merge policy
• pytest

PEP8

https://peps.python.org/pep-0008/

ruff

Developers just need to

pip install ruff

and then execute

ruff format `git rev-parse --show-toplevel`
# one can also add the --diff option to have a dry-run of how ruff would format the files.

to achieve consistent formatting and

ruff check `git rev-parse --show-toplevel`

for static code analysis.

git-hook

One should eventually execute

git config --local core.hooksPath .githooks/

to enable local commit hooks, that can perform some simple sanity checks.

git merge policy

• cannot directly commit to main (also enforced by hook)
• PRs into main require at least one review
• squash commits upon merging
• use git merge instead of git rebase; this can be set with git config pull.rebase false for doing git pull

pytest

• How to execute pytest locally
• Document environment variables QUEMB_DO_KNOWN_TO_FAIL_TESTS and QUEMB_SKIP_EXPENSIVE_TESTS

[mscho527]

Maybe a few things about the pytest test suite?