diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 000000000..8e603d86f --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# Black formatting +3789fdd9225f5bf7f871af1e69ae11cca90cd555 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5db79c7bd..b46233eae 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