Collaborators wanted!

[knsv]

Background

I started this project by myself in the second half of 2014 mainly for my own needs for documentation. At the time I had no idea it would gain so much traction. This has been a great thing to watch. Open source in action. Many people started using it, many people added support for mermaid in their editors/wikis etc. Many people helped develop this further in the form of pull requests.

After some time other projects started to require more of my time and I asked for help from the community and that was when @tylerlong volunteered to help maintaining the project.

Now it is again time to ask the community for assistance. We have many things coming up and want to keep the pulse of the project beating steady.

Are you someone who wants to take an active role in improving mermaid?

Look at the list of areas we need help with:

• Development - help solving issues
• Development - work with the build environment, with JS we keep updating the tools we use
• Development - new diagram types
• Development - Handling Pull Requests
• Test - testing in connection with releases, regression testing
• Test - verification of fixed issues
• Test - test of pull requests and verification testing
• Release management - more of a PL role, make roadmap for the project, coordinating the work
• Release management - classification and monitoring of incoming issues

Join our slack community if you want closer contact!

Where can you start?

• You could confirm the bugs in these issues.
• You could help write and improve the documentation! Here's some inspiration.
• You could start getting some knowledge of the code base by working on these "good first issues".
• You could jump right in and help us fix any of these bugs!
• You could work on a new feature! These are some ideas!

Detailed information about contributing can be found in the contribution guide.

[ThePenguin1140]

Hey @knsv I started using mermaid for PM and architecture diagrams at work and would love to give back. Let me know if you're still looking for people.

[sandyleo26]

Hi @knsv First thanks for creating such an interesting project!

I'm relatively new to mermaid which is introduced by a colleague. I'm backend engineer but still I'm appalled that I didn't discover this tool earlier. I'd like to give it a bit of my time if that can help.

[knsv]

Good news! I think first order of business is to get a good communications platform for discussions and perhaps even screensharing.

Here is an invite to a slack channel where we can start off. I could not find any free means of screensharing so maybe we move if we need to.

https://join.slack.com/t/mermaid-talk/shared_invite/enQtNjg0MDI2OTg5OTQzLTg2YjcxMzA2NzVmYTkwMzc4MGUwNDkyMjVjZmY1OGE5YzVjNTI0MjQwZGQwYmYyMzg3YjRhZjQ5NjAzMWU2MmI

[cristianocasella]

I can help, maybe I can't give a strong help on the developer side but I can on the release management and test.
Let me know

[wires]

you could use appear.in for screensharing or even twitch.tv

[trueskawka]

I'd love to support the project :) joined Slack

[DanShai]

im in too whenever im free :)

[nskoretz]

I find mermaid super useful. I'll see if I can pitch in anywhere.

[knsv]

@nskoretz sounds great!

[arthanzel]

Hello! Javascript dev @ GitLab here. We happily use mermaid in our product and I'm down to help where possible.

[GDFaber]

This project is awesome! I'm still new to mermaid and just using its flowchart functionality, but I'll happily put my two cents in if possible.

[hikerpig]

Mermaid is great! I'm trying to implement Plantuml-like stateDiagram, and would like to help solving issues.

[knsv]

💚 Join our slack community if you want closer contact!

https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzI4NDU5ODkzMTkxLTk3MDVmYmY5Y2ZjZThkZWQ2Y2ExMzVmOGQxZGEyZDFmZDI4OWE0NzZjOWJmOTVmNjkzMmM4YWI5ZjQzNmVhMzg

[ramirlm]

I wanna help you guys! Awesome project!! Joining slack channel

[l3zero]

this looks fun! I need all the JavaScript in my life right now, and this would be my first open source collaboration! Thanks for starting this, and it gives me ideas and inspiration to do the same in the future.

[fulldecent]

@knsv Hello, I hear you loud and clear about needing assistance. I helped with Chart.js when that project went from one developer to a team.

Please consider to add a STRONG Project Scope section in README.md. This will make it very clear what things are INSIDE the project and what is OUTSIDE.

First, it allows you, me, anyone, to politely close issues that are outside this scope. This has anpolynomial effect on cleaning up issues.

Next, it allows people to help, because they know what they are getting involved in. Also, this allows you to quickly vet contributors that you will grant commit access.

I can help here by doing triage. But only if there is an objective scope to go by.

[dbartholomae]

Is this still relevant? I'm using Mermaid a lot recently, so would love to give back a bit. What would be the most helpful way to get started on this?

[Penguinlay]

Do you still need help?

[brunolnetto]

The first bullet point has only one issue. The last two bullet points are empty. It seems people jumped in very hardly. First issues do not seem to be first. I am looking for a state diagram with colored states and edges. I do not know if it is possible and, if so, how to reproduce it.

[ghost]

Hi everyone.

I'm helping as I can. I know frontend and I know ui/ux. Then I help with screen prototypes here in mermaid-js. So I would like to contribute to this repository.

[emersonbottero]

I made the docs and at the time the code highlight didn't worked for jison
,It was finally added
shikijs/shiki#367 (comment)

We probably want to review this in the near future.

[toolness]

Hi! I recently filed my first PR at #4367 but I noticed that there isn't a ton of documentation about how to get started developing Mermaid itself.

Most of it seems to be in CONTRIBUTING.md and while it describes how to install things and run pnpm test, there's a number of things it doesn't cover, e.g.:

• pnpm run dev starts a development server that automatically rebuilds the library on code changes, and starts a server at http://localhost:9000/ that has a bunch of cool example pages for each diagram
• pnpm cypress:open starts a cool cypress app that lets you run a bunch of front-end tests and see their output (and requires the pnpm run dev server to be up in order to work)
• There are at least two different kinds of test suites; one is the front-end cypress tests, another appears to be a set of unit tests that are run in node, and there might be more

I gleaned a bunch of this from reading package.json and poking around but I think it'd be great if it was in CONTRIBUTING.md. If others think this would be useful, I can submit a PR.

[huynhicode]

Hi! I recently filed my first PR at #4367 but I noticed that there isn't a ton of documentation about how to get started developing Mermaid itself.

Most of it seems to be in CONTRIBUTING.md and while it describes how to install things and run pnpm test, there's a number of things it doesn't cover, e.g.:

• pnpm run dev starts a development server that automatically rebuilds the library on code changes, and starts a server at http://localhost:9000/ that has a bunch of cool example pages for each diagram
• pnpm cypress:open starts a cool cypress app that lets you run a bunch of front-end tests and see their output (and requires the pnpm run dev server to be up in order to work)
• There are at least two different kinds of test suites; one is the front-end cypress tests, another appears to be a set of unit tests that are run in node, and there might be more

I gleaned a bunch of this from reading package.json and poking around but I think it'd be great if it was in CONTRIBUTING.md. If others think this would be useful, I can submit a PR.

@toolness Thanks for your contribution!

There is a working PR for revising the Contributing documentation. Take a look and jump in where you can!

[toolness]

Awesome, thanks @huynhicode !

[sidharthv96]

@toolness you can create a branch off of the PR @huynhicode mentioned and submit a new PR.

I'd really like to see that finished. Has some lovely work by @weedySeaDragon which we'd hate to see go to waste.

[nirname]

I am in

[weedySeaDragon]

@sidharthv96 -- Quick note: Had some really bad health stuff. Started to get better, then really bad again.
But am slooowly a little better. Am slowly starting to poke around with code again.
I still have a lot of bad days, but am starting to also have some where I can poke around at things for short times. (Nature of this is somewhat random.)
I might be able to read or review things or throw in some ideas. Include me if you want and I'll contribute if I can. :-)

[sidharthv96]

Hey @weedySeaDragon, so happy to have you back!!
I just merged #3814 last week. It had some TODOs pending, but it was better to get it in, than let the docs diverge too much.
To catch you up, we're trying to standardize and document new diagram creation, so we can have more diagrams from the community. #4499

[WaveRunning]

hey! I would love to join you！

[sidharthv96]

Some issues that you can get started with:
https://github.com/mermaid-js/mermaid/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+first+issue%21%22

[Central3]

Hey! I am new to open source, I would like to make my first contribution here.

[ad1992]

If this is still open count me in