From 275e61832f4162792ddc1a3fff95a3ef81eedf9c Mon Sep 17 00:00:00 2001 From: "Hilary B. Brenum" Date: Tue, 15 Mar 2022 17:44:05 -0700 Subject: [PATCH] call out make fix-isort etc before code commit --- docs/contributing.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 0d0b456..b75fef3 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -14,11 +14,14 @@ This channel is bridged to Discord [here](https://discord.gg/QBHUUpeGUd) for con KMK uses [Black](https://github.com/psf/black) with a Python 3.6 target and, [(controversially?)](https://github.com/psf/black/issues/594) single quotes. Further code styling is enforced with isort and flake8 with several plugins. -`make fix-isort fix-formatting` before a commit is a good idea, and CI will fail -if inbound code does not adhere to these formatting rules. Some exceptions are -found in `setup.cfg` loosening the rules in isolated cases, notably -`user_keymaps` (which is *also* not subject to Black formatting for reasons -documented in `pyproject.toml`). + +**NOTE:** before committing code, run `make fix-istort fix-formatting test` to +reduce workload for the project's maintainers and prevent the CI pipeline from +failing. + +There are some limited exceptions to the code formatting rules, which can be +found in `setup.cfg`, notably around `user_keymaps` (which are also not subject +to Black formatting as documented in `pyproject.toml`) ### Tests