Skip to main content

Getting Involved

View as Markdown

The EventCatalog Miro App is open source and we welcome contributions of all kinds — from bug reports and feature requests to code contributions and documentation improvements.

Ways to contribute

Report bugs and request features

Found a bug or have an idea for a new feature? Open a GitHub issue and let us know. Please include as much detail as possible — screenshots, steps to reproduce, and what you expected to happen.

Join the community

Our Discord community is the best place to ask questions, share feedback, and connect with other users building with EventCatalog. We're active there and happy to help.

Contribute code

The app is built with React, TypeScript, and the Miro Web SDK. To get started:

  1. Fork the repository: github.com/event-catalog/eventcatalog-miro-app
  2. Clone your fork and install dependencies:
    git clone https://github.com/<your-username>/eventcatalog-miro-app.git
    cd eventcatalog-miro-app
    npm install
  3. Start the development server:
    npm run dev
  4. Make your changes and open a pull request

Improve the documentation

If you spot something missing or unclear in these docs, contributions are welcome. The documentation lives alongside the main EventCatalog website.

What we're looking for

The app is in beta and there are plenty of areas where help is appreciated:

  • Bug fixes — if you find something broken, a fix is always welcome
  • New features — check the issues page for feature requests or propose your own
  • Testing — try the app with your own catalog and let us know how it goes
  • Feedback — share what works well and what could be improved

Code of conduct

Please be kind and respectful in all interactions. We're building this together and every contribution matters.