Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (73 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

92 lines (73 loc) · 3.98 KB
Raw

Contributing to Threepipe

We welcome contributions to Threepipe. Please read the following guidelines to start working on the code and creating pull request.

Setting up the project

  1. Clone the repository
  2. Run npm install

Development

  1. Run npm run vite to run vite dev server and navigate to http://localhost:5173/examples/index.html
  2. Test the examples and pick the one you are working on.

OR

  1. If changing the src/ folder - Run npm run dev to start the development in watch mode
  2. If changing the plugins/ folder - cd to the plugin directory and run npm run dev to start the development in watch mode for the package.
  3. Run npm run dev-examples to start the examples build in watch mode and run npm run serve to start the development server, and navigate to http://localhost:9229/index.html

For website(vitepress) development -

  • Run npm run website:dev to start the website server.

Note: If you see Cannot access 'X' before initialization errors after adding or moving source files, delete the .vite/ cache folder and reload. Vite's transform cache can become stale when the module graph changes.

Some examples requires env variables.

  • Run cp examples/sample.env examples/.env and set the required tokens/keys in the examples/.env file, and build the examples again.

Testing

TBD

Building

  1. Run npm run build to build the project, or in a specific package directory to build the package
  2. Run npm run build-examples to build the examples
  3. Run npm run website:build to build the website
  4. Run npm run docs to build only the API docs
  5. Run npm run prepare to build the project, examples and plugins
  6. Run npm run docs-all to build API docs and website

Publishing

For core and for each package -

  • Update the package version in package.json and run npm run new:publish to publish the package to npm.
  • Add tag like v0.0.1 or @threepipe/plugin-name-0.0.1 to the git repository.
  • Push/Merge to master on github.

Creating a Core Plugin

Checklist

  • Create a class in a subfolder at ./src/plugins
  • Inherit from AViewerPluginSync
  • Set a unique PluginType
  • Write plugin
  • Add jsdoc comments to the class
  • Export classes, functions in ./src/plugins/index.ts
  • Optionally, use plugin in ./examples/tweakpane-editor/script.ts
  • Optionally, use plugin in ./examples/model-viewer/script.ts
  • Optionally, use plugin in threepipe-blueprint-editor
  • Create an example in ./examples by duplicating any existing one
  • Add example to ./examples/index.html
  • Add example and any other tests to tests/
  • Add info to README.md
  • Add info to ./website/guide/core-plugins.md
  • Add info to ./website/plugin/PluginName.md
  • Add entry to sidebar in ./website/.vitepress/config.ts
  • Update CHANGELOG.md

Creating a Package/Plugin package

Checklist

  • Duplicate a template plugin from plugins/ folder - plugin-template-vite
  • Change name, description, repository.directory, dependencies and any other relevant fields in package.json
  • Change name in typedoc.json
  • Update link in plugin's CHANGELOG.md and README.md
  • Check globals in vite.config.js
  • Write plugin/package
  • Add jsdoc comments to the classes
  • Export classes, functions in index.ts
  • Optionally, use plugin in ./examples/tweakpane-editor/script.ts
  • Optionally, use plugin in ./examples/model-viewer/script.ts
  • Optionally, use plugin in threepipe-blueprint-editor
  • Create an example in ./examples by duplicating any existing one. Ideally one example for each exported plugin/utility.
  • Add example to ./examples/index.html
  • Add example and any other tests to tests/
  • Add info to README.md
  • Add info to ./website/guide/threepipe-packages.md
  • Add info to ./website/package/plugin-name.md
  • Add entry to sidebar in ./website/.vitepress/config.ts
  • npm run build and test with example
  • Publish package with npm run new:publish. Check that tag is added to git like plugin-name-v0.0.1
  • Update core CHANGELOG.md with link to new package.