We receive contribution requests from time to time. We appreciate the warm-heart from the community. Here is a guide of contribution. Please make sure you have finished reading this guide before asking more questions.

Why

Contributing to this project can be boring. We have seen quite a few cases that people forked the project and asked a lot of questions around setting up the environment and left. We need a minimum level of commitment from you if you would like to contribute. Finishing reading this guide is a preliminary test for your patients to join the team.

What

This is a project with a financial goal. We have fairly ambitious financial goal in this project. It is not mandatory, but I recommend that you read this slide to understand who we are and what we are doing.

Where and how

There are mainly four parts that we need help with:

Plugin development

We currently have three plugins are under active development/maintenance.

Please avoid starting with asking questions like "how to build it locally", "how to test it locally" before you have tried a few things by yourself. The the README.md files in each of the project should give you a fairly good idea on those questions. If you have asked those questions and got an answer or if you have got answer by yourself, please add it to README or another descritpion file and submit a pull request.

Chrome extension

The Chrome extension is written in JavaScript (React+VueJs). You don't have to know VueJs as much as React to work on this project. Source code can be found at - https://github.com/ZenUml/web-sequence.

Confluence plugin

The Confluence plugin is written in JavaScript (VueJs). Source code can be found at - https://github.com/ZenUml/confluence-plugin. You main need some help to test it with a real Confluence instance. We can provide help but please make sure that you can run the demo (index.html) locally and understand how it works.

JetBrains plugin

The JetBrains plugin is written in Java and Kotlin. Source code can be found at - https://github.com/ZenUml/jetbrains-zenuml. You should be able to run the plugin locally without publishing it.

Core render development

The core render is a JavaScript library that runs within a browser to convert a piece of text into a DOM. You have to be ready to commit a lot more (mainly time) before you can contribute to the core render library. If you just want to use this library, it is published as an npm module. It is free of charge to be used anywhere.

The core render is not OSS.

Documentation

There is a lot of improvement need to be made in our documentation. Again it is not of much fun for everyone. The documentation is mainly to describe the feature as a tutorial and for SEO purpose.

Marketing

We need help in SEO, social media exposure.

Have the interest to join the core team?

Send an email to support@zenuml.com .