Add git blame ignore file #6362
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a new file with the SHA1 of commits to ignore when running git blame. This is important because of the recent adoption of black as our code formatting tool in Qiskit#6361 we caused a large amount of code churn to change the code formatting. However using the ignore file is a local opt-in feature for git and not something we can enable globally by default. To facilitate this a section is added to the bottom of the contributing guide to document how this file can be used.
This was referenced May 7, 2021
This was referenced Nov 17, 2021
mtreinish
added a commit
to mtreinish/qiskit-core
that referenced
this pull request
Feb 3, 2022
In the recently merged Qiskit#7615 we bumped the black version and constrained it to a stable version to keep us on a fixed set of formatting rules but also receiving bug fixes. In doing this some new formatting rules were applied to the repo (mainly `x ** y` was changed to `x**y`) by the new version of black. To reduce noise in the git blame this commit updates the .git-blame-ignore-revs file (which was added after we started using black in Qiskit#6362) to include the sha1 for this commit. This means that when running git blame on files this commit will be ignored (assuming the local git environment is configured correctly).
mergify bot
added a commit
that referenced
this pull request
Feb 3, 2022
In the recently merged #7615 we bumped the black version and constrained it to a stable version to keep us on a fixed set of formatting rules but also receiving bug fixes. In doing this some new formatting rules were applied to the repo (mainly `x ** y` was changed to `x**y`) by the new version of black. To reduce noise in the git blame this commit updates the .git-blame-ignore-revs file (which was added after we started using black in #6362) to include the sha1 for this commit. This means that when running git blame on files this commit will be ignored (assuming the local git environment is configured correctly). Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
ElePT
added a commit
to ElePT/qiskit-algorithms
that referenced
this pull request
Jul 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This commit adds a new file with the SHA1 of commits to ignore when
running git blame. This is important because of the recent adoption of
black as our code formatting tool in #6361 we caused a large amount of
code churn to change the code formatting. However using the ignore file
is a local opt-in feature for git and not something we can enable
globally by default. To facilitate this a section is added to the bottom
of the contributing guide to document how this file can be used.
Details and comments