diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000000..bb6e84f1e7 --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1 @@ +ff5a1aa98e77173b09b1b83575118e71f719216c diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe22e4232d..cccb08b6dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1102,3 +1102,28 @@ Now we can run the Python interpreter and pass the arguments (the python file to Target 0: (python) stopped. After this, you can step through the code and continue with your debug session as always. + + +## Dealing with the git blame ignore list + +In the qiskit-aer repository we maintain a list of commits for git blame to +ignore. This is mostly commits that are code style changes that don't change +the functionality but just change the code formatting (for example, when we +migrated to use black for code formatting). This file, `.git-blame-ignore-revs` +just contains a list of commit SHA1s you can tell git to ignore when using the +`git blame` command. This can be done one time with something like + +``` +git blame --ignore-revs-file .git-blame-ignore-revs qiskit/version.py + +``` + +from the root of the repository. If you'd like to enable this by default you +can update your local repository's configuration with: + +``` +git config blame.ignoreRevsFile .git-blame-ignore-revs +``` + +which will update your local repositories configuration to use the ignore list +by default.