Skip to content

Conversation

@mhucka
Copy link
Member

@mhucka mhucka commented Dec 9, 2025

Some trivial deviations from clang-format in a small number of files seem to have crept in over time. This meant that running the format check scripts in scripts/ could report changes that are not a contributors' actual changes. To prevent possible confusion to developers and maintainers, this commit:

  1. adds the results of running ./scripts/format_all.sh
  2. adds a .git-blame-ignore-revs file
  3. adds intructions to the contributor instructions to run git config blame.ignoreRevsFile on the file

⚠️ Maintainer notice ⚠️: this PR needs to be merged using the "Create a merge commit" strategy. Using "Squash and Merge" or "Rebase and Merge" will change the commit hash and render the entry in .git-blame-ignore-revs ineffective.

@mhucka mhucka added the area/health Involves general matters of project configuration, health, maintenance, and similar concerns label Dec 10, 2025
@mhucka mhucka changed the title [wip] Formatting only: run code through scripts/format_all.sh Formatting only: run code through scripts/format_all.sh Dec 10, 2025
@mhucka mhucka marked this pull request as ready for review December 10, 2025 23:46
Copy link
Collaborator

@MichaelBroughton MichaelBroughton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the formatting updates! Happy to merge those, but I don't think we should take on the extra maintenance burden of the the blame-ignore-revs here since it looks like it adds complexity for how we need to merge PRs that isn't worth putting on people anytime we have a formatting change that they want to add to this list. This is a small repo and we need to keep these sorts of things as small as possible.

@@ -0,0 +1,12 @@
# Usage: run the following command to configure git to use this file:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a neat feature, but it is more maintenance to keep up to date. I'd be inclined to just not bother here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/health Involves general matters of project configuration, health, maintenance, and similar concerns

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants