Skip to content

Contributing

Want to contribute to Photon? I'm always looking for new effects and filters, so your contributions would be greatly appreciated.

If you have bug reports or want to request features, do open an Issue on GitHub and I'll get right on it.

Workflow:

  1. Create your branch.
  2. Make your changes, for example, that could include improving documentation, adding new effects or filters, etc.,
  3. Make sure it runs with cargo run --release
  4. If you are writing WebAssembly-specific code, and wish to build an npm module, install wasm-pack and then run: wasm-pack build. A package called pkg will be outputted, you can then use this in the webpack demo provided in the repository.
  5. Create a Pull Request, and I'll review it! :D

Thanks so much for contributing!