Skip to content

Conversation

@bjorkert
Copy link
Contributor

Description

This pull request removes the // Created by {author} line from the file headers generated by our SwiftFormat script.

The swiftformat tool sources the author's name from the Git history. This has proven to be a source of instability and code churn for our project. Operations such as squashing commits during a merge can change the perceived author of a file in Git's history.

This leads to the // Created by... line fluctuating between different developers during routine builds, creating unnecessary diffs and noise in commits.

By removing this dynamic line from the header template, we ensure that file headers remain consistent and predictable across all development and CI environments. This change helps to reduce noise in our commit history and code reviews.

Changes Made

  • Updated the SwiftFormat execution script to modify the --header parameter.
    • Before: --header "LoopFollow\n{file}\nCreated by {author}."
    • After: --header "LoopFollow\n{file}"
  • Ran SwiftFormat across the entire project to apply the new, cleaner header to all relevant files.

@bjorkert bjorkert requested a review from marionbarker August 14, 2025 18:25
@codebymini
Copy link
Collaborator

Much appreciated!

Copy link
Collaborator

@marionbarker marionbarker left a comment

Choose a reason for hiding this comment

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

This fixes the current issue in which multiple files are modified by the script by building with Xcode.

Approve from code review and test. Only headers are modified and only the Created by line.

@marionbarker marionbarker merged commit 0b37743 into dev Aug 15, 2025
@marionbarker marionbarker deleted the remove-creator-from-header branch August 15, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants