This monorepo's main components:
Packages/com.unity.cloud.gltfast- Unity package for import/export of glTF 3D assetsPackages/com.unity.cloud.gltfast.tests- Unit and integration testsProjects/- Contains multiple Unity projects with different setups for development and testingProjects/glTFast-Test- main test project
- C# version: 9.0
- Never create
.metafiles directly. The Unity Editor will create them automatically - Prefer state return values over C# exceptions (that may not work in Web builds)
- Once code modifications are complete, ensure correct code format (as depicted by
.editorconfig) by runningdotnet format Projects/glTFast-Test/glTFast-Test.sln - Follow the .NET Framework Design Guidelines
- Code comments: write none by default. Only add one when the code can't be understood by reading it (hidden constraint, non-obvious invariant, workaround, surprising behavior).
- Not for design rationale, restating what the code does, or task/fix/caller refs.
- XML doc comments (
///) on public API are documentation, not commentary.
Optimize code for fast execution and minimize the amount of managed memory allocated.
- Prefer using
NativeCollectioncontainers such asNativeArrayover managed containers. - Parallelize data processing
- Prefer the C# job system (
IJob) - Alternatively use
System.Threading, minding the special behavior ofUnitySynchronizationContext
- Prefer the C# job system (
- Use the Burst compiler (
BurstCompileAttribute) where applicable