Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.58 KB

Contributing

We are currently in transitionary period. Follow TurboWarp/scratch-gui#633 for updates.

Before submitting new extensions or changes to extensions, please read:

We're still figuring out how local development will work.

New extensions

While you can host your custom extensions on any website, submitting them to extensions.turbowarp.org has several advantages:

  • The extension will run unsandboxed, so running blocks from your extension can be instant instead of having a forced 1-frame delay
  • The extension can be loaded automatically, without a prompt
  • Improved discoverability

We accept almost any extensions that follow these guidelines:

  • You agree to make the source code available under the MIT License. Either you must have written the entirety of the extension, or whoever wrote it has released the code under a compatible open source license.
  • No eval(), new Function(), remote scripts, or similar arbitrary JS/CSS/HTML/etc.

Just send a pull request adding an extension.js file with your extension's source code.

Updates to extensions

When updating extensions, you MUST retain compatibility with projects made with older versions of the extension. There are no exception to this rule. Specifically, this means:

  • You MUST NOT change the extension ID
  • You MUST NOT change or remove block IDs
  • You MUST NOT change argument names
  • You MUST NOT change block behavior in a way that would break projects