search

godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.94k stars 3.22k forks source link

Add short section on git lfs #8929

Open jtbourke opened 9 months ago

jtbourke commented 9 months ago

4.2.1:

Version Control chapter covers gitignore but doesn't mention git lfs setup, which is also important:

URL to the documentation page (if already existing):

I just asked a question on the forum and then realized other people might have the same question and it might be nice to add this to the docs: https://forum.godotengine.org/t/godot-binary-file-types-for-git-lfs-tracking/46681

The information on file types is found in the documentation, but spread out. Everyone who uses git lfs will need the same list of file types so it would be pretty simple to just provide a .gitattributes file that will work for everyone, and to provide a link to that in the documentation.

Maybe this is already provided somewhere and I missed it. I'm new to Godot.

I did find this list of binary files which is helpful for source art, but not game specific, and it is missing some of the files that Godot imports, such as dds: https://confluence.atlassian.com/bbkb/add-commonly-used-binaries-to-git-lfs-1188409676.html

ghost commented 9 months ago

Based on the comment by Calinou in the forum thread, these Godot-specific files are binary and therefore they should be lfs tracked:

This demonstrates the need for the documentation. If I hadn't asked the question and if Calinou hadn't been willing to assist, I don't know how I would discover those file types without discovering them during use.