Skip to content

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

Merged
merged 1 commit into from
Apr 23, 2025
Merged

Conversation

jaydensipe
Copy link
Contributor

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.

Copy link
Contributor

@skyace65 skyace65 left a 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.

@skyace65 skyace65 added area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement labels Apr 12, 2025
@tetrapod00
Copy link
Contributor

I'm okay with including this, even though it is only marginally in scope for the Godot docs. Including an example .gitattributes file also seems okay as a starting point (the text already clarifies it is a starting point). Maybe add another sentence explaining why these types are chosen?

@jaydensipe jaydensipe force-pushed the add-git-lfs-section branch from ad8d363 to c4727f1 Compare April 13, 2025 23:56
@jaydensipe
Copy link
Contributor Author

Maybe add another sentence explaining why these types are chosen?

Done!

@jaydensipe
Copy link
Contributor Author

jaydensipe commented Apr 14, 2025

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?

Copy link
Member

@mhilbrunner mhilbrunner left a 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!

@jaydensipe jaydensipe force-pushed the add-git-lfs-section branch from c4727f1 to 398a4db Compare April 14, 2025 22:43
@skyace65 skyace65 merged commit 10016f5 into godotengine:master Apr 23, 2025
1 check passed
@skyace65
Copy link
Contributor

Thanks! And congrats on your first merged PR!

@jaydensipe jaydensipe deleted the add-git-lfs-section branch April 24, 2025 00:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add short section on git lfs
4 participants