Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 5.52 KB

CONTRIBUTING.md

File metadata and controls

97 lines (62 loc) · 5.52 KB

Contributing

Contributions are welcome and will be fully credited.

Please read and understand the contribution guide before creating an issue or pull request.

Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

Security

If you discover a security vulnerability, please refer to our Security Policy for reporting instructions.

Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.

Procedure

Before filing an issue:

  • Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. Create a CodeSandbox to reproduce the issue. Use one of these templates to get started:
  • Check to make sure your feature suggestion isn't already present within the project.
  • Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
  • Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

  • Check the codebase to ensure that your feature doesn't already exist.
  • Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

Before committing:

  • Make sure to run the tests and linter before committing your changes.
  • If you are making changes to one of the packages, make sure to always include a changeset in your PR describing what changed with a description of the change. Those are responsible for changelog creation

Create a new demo

To make it easier to add new demos to the demos app we provide a small helper script via pnpm run make:demo that scaffolds a new demo directory from our default template.

What it does

  • Prompts for a demo name and category.
  • Validates the category is one of: Dev, Examples, Extensions, Experiments, Marks, Nodes.
  • Copies the template demos/src/Examples/Default to demos/src/<Category>/<Demo_Name>.

How to use

  • From the repository root run:
  • If the script is executable:
  • Or with bash directly:
  • Follow the interactive prompts for the demo name and category.

Notes and follow-up steps

  • The script only copies the template. After the scaffold is created, update the demo's files (title, description, imports) to reflect your example.
  • Make sure to review the generated demo in demos/ and run the demos app (pnpm dev) to verify it appears and works as expected.
  • If your demo changes package behaviour or exposes user-facing changes, follow the normal rule and add a changeset and tests as needed.
  • If you don't want your demo to be included in the Git repository, use the Dev category. Demos in this category are ignored by git via .gitignore.

Publishing New Packages

When adding a new package to the repository that does not yet exist on NPM, additional setup is required before the automated publish CI can release it:

  1. Manual initial publish - The package must be published manually to NPM for the first time using normal user authentication. This is required because trusted publishing can only be configured for packages that already exist on the registry.
    • For a single package, run pnpm run build && pnpm publish from the package directory (e.g., packages/extension-audio/).
    • Alternatively, run pnpm run publish from the root directory to publish all packages.
  2. Configure trusted publishing - After the initial publish, set up NPM trusted publishing (also known as provenance) for the package on NPM. This allows the GitHub Actions workflow to publish subsequent versions automatically.

Without this setup, the publish CI will fail when attempting to release a new package.

Requirements

If the project maintainer has any additional requirements, you will find them listed here.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Happy coding!