From 16a63c5eb67bbe275f26bae467b8fc792df67bef Mon Sep 17 00:00:00 2001 From: Pierre Equoy Date: Thu, 11 Apr 2024 17:14:56 +0800 Subject: [PATCH] Add .git-blame-ignore-revs and update contrib guide (infra) (#1177) Add .git-blame-ignore-revs and update contrib guide --- .git-blame-ignore-revs | 2 ++ CONTRIBUTING.md | 2 ++ 2 files changed, 4 insertions(+) create mode 100644 .git-blame-ignore-revs diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000000..8e603d86ff --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# Black formatting +3789fdd9225f5bf7f871af1e69ae11cca90cd555 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5db79c7bd8..b46233eaee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,8 @@ its providers and its documentation. ## General recommendations - The codebase uses [black] for formatting, with `line-length` set to `79`. +- Install [black] inside your virtual environment using pip instead of using +Debian packages from apt, as the versions in pip are more up-to-date. - Use `git config blame.ignoreRevsFile .git-blame-ignore-revs` if you want to [ignore commits related to black formatting]. - Setup your editor of choice to run [autopep8] on save. This helps keep