Folder and File Structure standards?
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with SubmittingModels.md and review the proposed “Folder and File Structure” section, along with the typos mentioned in the issue. Confirm the folder and file rules with contributors, then update the documentation so the agreed standards and typo fixes are included.
Written by the indexing model from the issue text.
Description
I think we could use some standardization for folders and files.
There are a few of the unwritten rules I learned from other contributors a few years ago, when I started submitting assets to these repos.
I think these rules should be codified into the SubmittingModels.md documentation, but I would like feedback from other contributors before we add this additional section. There are also a few typos in the md, but those shouldn't require discussion.
I propose to add this section to SubmittingModels.md :
Folder and File Structure
Folder and file names must be consistent as this helps with tooling and automation.
- Asset top folder should use the same name as the
.gltffile in the/glTFsubfolder.- For example
Models/ABeautifulGamematchesModels/ABeautifulGame/glTF/ABeautifulGame.gltf
- For example
metadata.jsonfile containing the asset metadata (see below).README.body.mdfile containing the asset description (see below)./glTFsubfolder is mandatory, it should contain the asset with JSON .gltf, .bin, and all individual resources (such as textures).- PNG textures are preferred to avoid compression artifacts; if a variant is desired with .jpeg resources it can be provided in a
/glTF-JPGsubfolder (see below).
- PNG textures are preferred to avoid compression artifacts; if a variant is desired with .jpeg resources it can be provided in a
/screenshotsubfolder is mandatory, it should contain the screenshot plus any other resources used in the README.md./glTF-Binarysubfolder is optional, if a variant is included for a binary .glb./glTF-Dracosubfolder is optional, if a variant is included with compressed geometry using the extension KHR_draco_mesh_compression./glTF-Embeddedsubfolder is optional, if a variant is included for an embedded .gltf./glTF-IBLsubfolder is optional, if a variant is included using custom image-based lighting; for example with the extension EXT_lights_image_based./glTF-JPGsubfolder is optional, if a variant is included using resources in compressed .jpeg format./glTF-KTX-BasisUsubfolder is optional, if a variant is included with compressed textures using the extension KHR_texture_basisu./glTF-Quantizedsubfolder is optional, if a variant is included with compressed geometry using the extension KHR_mesh_quantization.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 108
- Avg merge
- 9h 39m
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from KhronosGroup/glTF-Sample-Assets
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 25/100
KhronosGroup/glTF-Sample-Assets#295 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
-
conformance test
Difficulty 3/5 1-2 days Newbie friendliness 72/100
KhronosGroup/glTF-Sample-Assets#284 · 4 comments ·
-
conformance test
Difficulty 5/5 Over a week Newbie friendliness 35/100
KhronosGroup/glTF-Sample-Assets#283 · 1 comment ·
All issues in KhronosGroup/glTF-Sample-Assets
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100