Skip to content

Contributing ​

The project is open source, and contributions are welcome.

Get set up ​

Follow Local development to run the project. Copy .env.example to .env first, so the database, storage, and auth are configured.

Ways to help ​

  • Report a bug or request a feature by opening an issue in the repository.
  • Improve the documentation.
  • Fix a bug or build a feature and open a pull request.

Before you open a pull request ​

  • Keep changes focused and describe what and why.
  • Match the style of the code around your change.
  • Run the type check and make sure the app still builds and runs.
  • Note the boundary between the app and the editor: the editor is plain browser JavaScript, not part of the bundler build. See Project structure.

License of contributions ​

Contributions are made under the project's license. By contributing, you agree your work is provided under those terms.