From 7b4ca4bd90c148d72548048f5109537a555aaf77 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Felix=20Hild=C3=A9n?= Date: Mon, 19 Apr 2021 00:18:39 +0300 Subject: [PATCH] Instructions on documenting code style modifications (#2109) --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd6ebfc..f2a4ee2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,12 @@ To workout X, please use is not perfect but saves a lot of release overhead as now the releaser does not need to go back and workout what to add to the `CHANGES.md` for each release. +### Style Changes + +If a change would affect the advertised code style, please modify the documentation (The +_Black_ code style) to reflect that change. Patches that fix unintended bugs in +formatting don't need to be mentioned separately though. + ### Docs Testing If you make changes to docs, you can test they still build locally too. -- 2.39.5