| 1 |
# `git blame` master ignore list. |
| 2 |
# |
| 3 |
# This file contains a list of git hashes of revisions to be ignored |
| 4 |
# by `git blame`. These revisions are considered "unimportant" in |
| 5 |
# that they are unlikely to be what you are interested in when blaming. |
| 6 |
# They are typically expected to be formatting-only changes. |
| 7 |
# |
| 8 |
# It can be used for `git blame` using `--ignore-revs-file` or by |
| 9 |
# setting `blame.ignoreRevsFile` in the `git config`[1]. |
| 10 |
# |
| 11 |
# Ignore these commits when reporting with blame. Calling |
| 12 |
# |
| 13 |
# git blame --ignore-revs-file .git-blame-ignore-revs |
| 14 |
# |
| 15 |
# will tell `git blame` to ignore changes made by these revisions when |
| 16 |
# assigning blame, as if the change never happened. |
| 17 |
# |
| 18 |
# You can enable this as a default for your local repository by |
| 19 |
# running |
| 20 |
# |
| 21 |
# git config blame.ignoreRevsFile .git-blame-ignore-revs |
| 22 |
# |
| 23 |
# This will probably be automatically picked by your IDE |
| 24 |
# (VSCode+GitLens and JetBrains products are confirmed to do this). |
| 25 |
# |
| 26 |
# Important: if you are switching to a branch without this file, |
| 27 |
# `git blame` will fail with an error. |
| 28 |
# |
| 29 |
# GitHub also excludes the commits listed below from its "Blame" |
| 30 |
# views[2][3]. |
| 31 |
# |
| 32 |
# [1]: https://git-scm.com/docs/git-blame#Documentation/git-blame.txt-blameignoreRevsFile |
| 33 |
# [2]: https://github.blog/changelog/2022-03-24-ignore-commits-in-the-blame-view-beta/ |
| 34 |
# [3]: https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view |
| 35 |
# |
| 36 |
# Guidelines: |
| 37 |
# - Only large (generally automated) reformatting or renaming PRs |
| 38 |
# should be added to this list. Do not put things here just because |
| 39 |
# you feel they are trivial or unimportant. If in doubt, do not put |
| 40 |
# it on this list. |
| 41 |
# - When adding a single revision, use a comment on top of the line |
| 42 |
# to link relevant issue/PR. Alternatively, paste the commit title |
| 43 |
# instead. |
| 44 |
# Example: |
| 45 |
# # https://github.com/sanitizers/octomachinery/issues/1 |
| 46 |
# d4a8b7307acc2dc8a8833ccfa65426ad28b3ffc9 |
| 47 |
# - When adding multiple revisions (like a bulk of work over many |
| 48 |
# commits), organize them in blocks. Precede each such block with a |
| 49 |
# comment starting with the word "START", followed by a link to the |
| 50 |
# relevant issue or PR. Add a similar comment after the last block |
| 51 |
# line but use the word "END", followed by the same link. |
| 52 |
# Alternatively, add or augment the link with a text motivation and |
| 53 |
# description of work performed in each commit. |
| 54 |
# Before each individual commit in the block, add an inline comment |
| 55 |
# with the commit title line. |
| 56 |
# Example: |
| 57 |
# # START https://github.com/sanitizers/octomachinery/issues/1 |
| 58 |
# # Bulk-replace smile emojis with unicorns |
| 59 |
# 6f0bd2d8a1e6cd2e794cd39976e9756e0c85ac66 |
| 60 |
# # Replace double with single quotes |
| 61 |
# d53974df11dbc22cbea9dc7dcbc9896c25979a27 |
| 62 |
# ... <rest of the list> |
| 63 |
# # END https://github.com/sanitizers/octomachinery/issues/1 |
| 64 |
# - Only put full 40-character hashes on this list (not short hashes |
| 65 |
# or any other revision reference). |
| 66 |
# - Append to the bottom of the file, regardless of the chronological |
| 67 |
# order of the revisions. Revisions within blocks should be in |
| 68 |
# chronological order from oldest to newest. |
| 69 |
# - Because you must use a hash, you need to append to this list in a |
| 70 |
# follow-up PR to the actual reformatting PR that you are trying to |
| 71 |
# ignore. This approach helps avoid issues with arbitrary rebases |
| 72 |
# and squashes while the pull request is in progress. |
| 73 |
|
| 74 |
|
| 75 |
# 🤖 Process docstrings with docformatter |
| 76 |
deeb3ae64c8039d136dbe958b2301049d8dfae72 |