2.6 KB63 lines
Blame
1> **Warning**
2>
3> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4>
5> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/intro.md](../../packages/mermaid/src/docs/community/intro.md).
6
7# Getting Started
8
9So you want to help? That's great!
10
11![Image of happy people jumping with excitement](https://media.giphy.com/media/BlVnrxJgTGsUw/giphy.gif)
12
13Here are a few things to get you started on the right path.
14
15## How can I help?
16
17```mermaid
18mindmap
19 root)Contributing(
20 Development
21 Solving issues
22 Adding new diagrams
23 Handling pull requests
24 Updating tooling
25 Testing
26 Verification of fixed issues
27 Regression testing in connection with releases
28 Testing pull requests
29 Management
30 Coordinating the work
31 Classification and monitoring of incoming issues
32```
33
34## Join the Development
35
36> **💡 Tip**
37> **Check out our** [**detailed contribution guide**](./contributing.md).
38
39Where to start:
40
41- You could start getting some knowledge of the code base by working on [these "good first issues"](https://github.com/mermaid-js/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22+).
42- You could jump right in and help us fix any of [these bugs](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug+%2F+Error%22++label%3A%22Contributor+needed%22+)!
43- You could help write and [improve the documentation](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22).
44- You could work on a new feature! [These](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Development%22+label%3A%22Type%3A+Enhancement%22+label%3A%22Status%3A+Approved%22+) are some ideas!
45- You could confirm the bugs in [these issues](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Status%3A+Triage%22++label%3A%22Type%3A+Bug+%2F+Error%22).
46
47[You can join our Discord server if you want closer contact!](https://discord.gg/sKeNQX4Wtj)
48
49## A Question Or a Suggestion?
50
51> **💡 Tip**
52> **Have a look at** [**how to open an issue**](./questions-and-suggestions.md).
53
54If you have faced a vulnerability [report it to us](./security.md).
55
56## Last Words
57
58Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So, if you get stuck, ask for help and hints in the Slack forum. If you want to show off something good, show it off there.
59
60[You can join our Discord server if you want closer contact!](https://discord.gg/sKeNQX4Wtj)
61
62![Image of superhero wishing you good luck](https://media.giphy.com/media/l49JHz7kJvl6MCj3G/giphy.gif)
63