Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce LF ending for commits & check out #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Introduce LF ending for commits & check out #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# We'll let Git's auto-detection algorithm infer if a file is text. If it is,
# enforce LF line endings regardless of OS or git configurations.

# More about LF vs. CRLF on the link below:
# https://www.aleksandrhovhannisyan.com/blog/crlf-vs-lf-normalizing-line-endings-in-git/

* text=auto eol=lf
Copy link
Member

Choose a reason for hiding this comment

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

I'm anxious about the auto and the need to try and have an exhaustive list of binary files otherwise we might brick a binary file ... that sounds like a very unpleasant experience! For example, we're missing pdf below, which I assume that git will properly identify as a binary, but it's weird that we would need to specify things like png but not pdf!? So, I think we should change the experience here. We should add all the files that we know we wnt to have LF line-endings and never possibly brick any files. The failure experience here better, a developer has to come and update the .gitattributes file if we had forgotten to add a particular file type, but no files are bricked!

Please also add a comment in here about how to renormalize all files for the inevitable case that we'll need to run that command when one of us adds another text file extension.


# Isolate binary files in case the auto-detection algorithm fails and
# marks them as text files (which could brick them).
*.{png,jpg,jpeg,gif,webp,woff,woff2} binary