Contributing

This project consists of multiple NPM packages, managed in one repository with Lerna. All code, excluding Node.js-based tests, is written in TypeScript. I recommend using VSCode for linting and type information, which becomes especially helpful when dealing with glTF schema objects.

After cloning the repository, run:

yarn install

The project relies on Yarn workspaces and will not build with npm. To build and test all code, run:

yarn run dist
yarn test

To run an arbitrary command across all packages:

lerna exec -- <command>

While working, use yarn run watch to watch and rebuild code after changes. To use a local version of the CLI, run yarn link within the packages/cli directory. Then gltf-transform -h will use local code instead of any global installation.

Pull requests

Before adding new features or packages to the repository, please open an issue on GitHub to discuss your proposal. Some features may not fit the current scope of the project, or may be more than I am able to maintain long-term. Even if a feature does not end up in this repository, custom transform functions can be defined and used externally.

New features should be compatible with both Node.js and Web, though exceptions may be possible in certain situations. To accomplish that, any platform-specific resources (like instances of HTMLCanvasElement or headless-gl) are passed into API functions by the user, rather than being created by the API directly.

Dependencies

I recommend compiling with Node.js v12.x, which is the latest version with a prebuilt binary for gl as of April 2020.

Runtime dependencies should be installed only to the sub-package in which they are needed. Any devDependencies are shared across all packages, and should be installed in the project root. Pull requests should omit any changes to dist/* artifacts. Changes including test coverage are strongly preferred.

Roadmap

glTF-Transform supports the complete glTF 2.0 core format, and some extensions. Most official Khronos Group extensions (those prefixed with KHR_) will be implemented on a rolling basis — pull requests are very welcome. Multi-vendor extensions (prefixed with EXT_) may be included on a case-by-case basis. Single-vendor extensions (any other prefix) are unlikely to be included directly in the project, although glTF-Transform does provide APIs to build and maintain implementations for those extensions externally.

Suggestions and PRs for new Library functions are also generally welcome.

Releasing

NOTE: Only the maintainer can create new releases.

All packages are published together. To create a standard release:

lerna publish [ patch | minor | major ] --force-publish "*" --otp <OTP>

To create an alpha release:

lerna publish prerelease --dist-tag alpha --force-publish "*" --otp <OTP>

If a release contains a new package, -- --access public must be appended. Lerna has historically been finicky with 2FA OTPs.

Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy TypeDoc documentation Copyright 2020 under MIT license