-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Add Git LFS section #10857
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.
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
Add Git LFS section #10857
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammar and spelling wise this looks good. However I'd like to get consensus from other maintainers before a merge. Unlike the existing section of this page none of this is Godot specific except for the example gitattributes files. And even that isn't something people strictly need to adhere to like the excluded files and folders at the top of the page. Some may choose to use LFS for image files like pngs, and others may choose not to, there's no technical reason you have to do it one way.
At minimum however I would say there is value in pointing people towards official LFS documentation, especially for projects with 3D models.
I'm okay with including this, even though it is only marginally in scope for the Godot docs. Including an example |
ad8d363
to
c4727f1
Compare
Done! |
Should we include a warning about potential costs with Git LFS due to file storage, or would the official Git docs suffice for something like this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm somewhat hesitant to add more docs for external, non-Godot-specific tooling, even though I don't particularly like slippery slope arguments, we need to try to avoid scope creep.
However, seeing as (a tiny bit) of this configuration is actually Godot specific and saves Godot users some time, and that searching for git lfs godot
did turn up a few, but not a ton of specific tutorials, I think I am fine with merging this for now, unless we have some better authority to link to.
Thanks for writing it!
c4727f1
to
398a4db
Compare
Thanks! And congrats on your first merged PR! |
Closes #8929
I've recently added Git LFS to my project and thought I could write this as the setup is still fresh in my mind. I'm still new to Git LFS, so this might not contain all the nuances, but could still be useful to have.