Contributing

April 29, 2026 · View on GitHub

This project uses GitHub to track issues and manage our source code.

This project uses TypeScript, a superset of the JavaScript programming language.

This project uses Bun as our development environment.

  • Check out the Bun Docs to learn more.
  • (It's similar to other JavaScript tools like Node/Jest/Esbuild/Vite, so knowing any of those already will help you a lot).
  • Bun supports both JavaScript and TypeScript.

If you want to contribute to temaki, you'll probably need to:

  • Install Bun
  • git clone https://github.com/rapideditor/temaki.git
  • cd into the project folder
  • bun install the dependencies

As you change things, you'll want to bun run all to ensure that things are working. (This command runs clean, check, metadata, and dist to type-check and rebuild the spritesheets.)

You can also type-check the project without emitting files:

  • bun run check:ts — runs tsc --noEmit across all source and script files.

You can also test the preview page in a local server:

  • bun start - then open http://127.0.0.1:8080/ in a browser.

It's also good to check on the dependencies sometimes with commands like:

  • bun outdated - what packages have updates available?
  • bun update --interactive - choose which updates to apply

Try to keep things simple!

AI-Assisted Contributions

We welcome contributions made with the help of AI tools. If you use them, you are responsible for understanding and reviewing the output before submitting it. Generated code, issues, and PR descriptions should be clear and relevant — not verbose for the sake of it.