From 55f13a2aca84fee91142e481774ce3b3b8afdfd3 Mon Sep 17 00:00:00 2001 From: Mike Taves Date: Fri, 15 Nov 2024 09:38:32 +1300 Subject: [PATCH] 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 +```