Create .git-blame-ignore-revs

[jonathantneal]

Changes

• Adds a .git-blame-ignore-revs file.
• Useful for ignoring mass reformatting commits. ^ref
• Supported in GitLens. ^ref
• Support coming to GitHub (recently given high priority). ^ref
• Works with git config blame.ignoreRevsFile .git-blame-ignore-revs

Testing

git config only

Docs

git config only

[changeset-bot]

⚠️ No Changeset found

Latest commit: a7476e6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[netlify]

✔️ Deploy Preview for astro-www ready!

🔨 Explore the source changes: a64dca3

🔍 Inspect the deploy log: https://app.netlify.com/sites/astro-www/deploys/61c39719be4d570007a352c0

😎 Browse the preview: https://deploy-preview-2254--astro-www.netlify.app

[netlify]

✔️ Deploy Preview for astro-docs-2 ready!

🔨 Explore the source changes: a64dca3

🔍 Inspect the deploy log: https://app.netlify.com/sites/astro-docs-2/deploys/61c397198be63a0007e4e65e

😎 Browse the preview: https://deploy-preview-2254--astro-docs-2.netlify.app

[jasikpark]

Nice! Might be worth adding git config --add blame.ignorerevsfile .git-blame-ignore-revs? Is it possible to commit that as a repo-local commit?

For me it added

[core]
        repositoryformatversion = 0
        filemode = true
        bare = false
        logallrefupdates = true
[remote "origin"]
        url = https://github.com/withastro/astro.git
        fetch = +refs/heads/*:refs/remotes/origin/*
[branch "main"]
        remote = origin
        merge = refs/heads/main
[branch "jn.add-git-blame-ignore-revs"]
        remote = origin
        merge = refs/heads/jn.add-git-blame-ignore-revs
        github-pr-owner-number = "withastro#astro#2254"
+[blame]
+       ignorerevsfile = .git-blame-ignore-revs

Which I assume would be updated on push maybe? And then generally respected rather than requiring everyone to set it up?

[jasikpark]

After that change to the git config Git Lens correctly ignored the mass formatting change!

[natemoo-re]

I added a quick note about setting this up to CONTRIBUTING.md! Looks good to me.