From 4d87faad9fe756fbb98df52a1e7c28e1a4132949 Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Thu, 14 Nov 2024 09:40:10 +1300 Subject: [PATCH 1/2] chore: add .git-blame-ignore-revs --- .git-blame-ignore-revs | 20 ++++++++++++++++++++ 1 file changed, 20 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 000000000..1d0306afd --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,20 @@ +# Introduce end-of-line normalization (#913) +de38a5bb9559a4acb14317a9038ce8267c432c03 + +# Initial GitHub actions for linting (#954) +675d12b07b1c7f93c2bce9da29790cf364d52505 + +# apply consistent multi-line string formatting (#1166) +2912b1dfc3fbfc926128702f222b7b1ca9f15c6c + +# use f-strings to format str (#1212) +5d4324ddb6ed5abad231295d63e28cdf779e5e07 + +# consistently use relative imports (#1330) +16b84e8e7933b98c63eaa4fbeb47f6e28a45d611 + +# switch to ruff, ignore known test warnings, numpy compat fixes (#2124) +b142b081516e6ac78e426257c7472dd4a9994b89 + +# reformat codebase with longer line length (#2362) +12a3bcd1ba8b229e00e2da8a448e7866c16fdb29 From 55f13a2aca84fee91142e481774ce3b3b8afdfd3 Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Fri, 15 Nov 2024 09:38:32 +1300 Subject: [PATCH 2/2] Add optional configuration for git-blame in DEVELOPER.md --- DEVELOPER.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/DEVELOPER.md b/DEVELOPER.md index eebaf78d5..274545047 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -50,6 +50,12 @@ To develop FloPy you must have the following software installed on your machine: You will need [Git](https://git-scm.com) and/or the **GitHub app** (for [Mac](https://mac.github.com) or [Windows](https://windows.github.com)). GitHub's [Guide to Installing Git](https://help.github.com/articles/set-up-git) is a good source of information. +Optionally, the [`git blame`](https://git-scm.com/docs/git-blame) tool can be configured to work locally using: + +```shell +git config blame.ignoreRevsFile .git-blame-ignore-revs +``` + ### Python FloPy supports several recent versions of Python, loosely following [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#implementation). @@ -415,4 +421,4 @@ For a script in a subdirectory of the root, for instance, the conventional appro ```Python project_root_path = Path(__file__).parent.parent -``` \ No newline at end of file +```