CONTRIBUTING.md 4.41 KB
Newer Older
1
# Contributing to Grafana
David Kaltschmidt's avatar
David Kaltschmidt committed
2

3
Thank you for your interest in contributing to Grafana! We welcome all people who want to contribute in a healthy and constructive manner within our community. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
David Kaltschmidt's avatar
David Kaltschmidt committed
4

5
This document is a guide to help you through the process of contributing to Grafana.
David Kaltschmidt's avatar
David Kaltschmidt committed
6

7
## Become a contributor
David Kaltschmidt's avatar
David Kaltschmidt committed
8

9
You can contribute to Grafana in several ways. Here are some examples:
David Kaltschmidt's avatar
David Kaltschmidt committed
10

11
12
13
14
15
16
- Contribute to the Grafana codebase.
- Report and triage bugs.
- Develop community plugins and dashboards.
- Write technical documentation and blog posts, for users and contributors.
- Organize meetups and user groups in your local area.
- Help others by answering questions about Grafana.
bergquist's avatar
bergquist committed
17

18
For more ways to contribute, check out the [Open Source Guides](https://opensource.guide/how-to-contribute/).
David Kaltschmidt's avatar
David Kaltschmidt committed
19

20
### Report bugs
David Kaltschmidt's avatar
David Kaltschmidt committed
21

22
23
Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the [existing issues](https://github.com/grafana/grafana/issues) for similar issues.

24
Report a bug by submitting a [bug report](https://github.com/grafana/grafana/issues/new?labels=type%3A+bug&template=1-bug_report.md). Make sure that you provide as much information as possible on how to reproduce the bug.
David Kaltschmidt's avatar
David Kaltschmidt committed
25

26
27
28
29
30
31
32
33
34
35
Follow the issue template and add additional information that will help us replicate the problem.

For data visualization issues:
- Query results from the inspect drawer (data tab & query inspector)
- Panel settings can be extracted in the panel inspect drawer JSON tab

For a dashboard related issues:
- Dashboard JSON can be found in the dashboard settings JSON model view

For authentication and alerting Grafana server logs are useful.
36

37
#### Security issues
38

39
If you believe you've found a security vulnerability, please read our [security policy](https://github.com/grafana/grafana/security/policy) for more details.
David Kaltschmidt's avatar
David Kaltschmidt committed
40

41
### Suggest enhancements
42

43
If you have an idea of how to improve Grafana, submit an [enhancement request](https://github.com/grafana/grafana/issues/new?labels=type%3A+feature+request&template=2-feature_request.md).
44

45
We want to make Grafana accessible to even more people. Submit an [accessibility issue](https://github.com/grafana/grafana/issues/new?labels=type%3A+accessibility&template=3-accessibility.md) to help us understand what we can improve.
46
47
48
49
50
51
52
53
54
55
56
57
58

### Triage issues

If you don't have the knowledge or time to code, consider helping with _issue triage_. The community will thank you for saving them time by spending some of yours.

Read more about the ways you can [Triage issues](/contribute/triage-issues.md).

### Answering questions

If you have a question and you can't find the answer in the [documentation](https://grafana.com/docs/), the next step is to ask it on the [community site](https://community.grafana.com/).

It's important to us to help these users, and we'd love your help. Sign up to our [community site](https://community.grafana.com/), and start helping other Grafana users by answering their questions.

59
### Your first contribution
60

61
Unsure where to begin contributing to Grafana? Start by browsing issues labeled `beginner friendly` or `help wanted`.
62

63
64
- [Beginner-friendly](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22beginner+friendly%22) issues are generally straightforward to complete.
- [Help wanted](https://github.com/grafana/grafana/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues are problems we would like the community to help us with regardless of complexity.
65

Marcus Olsson's avatar
Marcus Olsson committed
66
If you're looking to make a code change, see how to set up your environment for [local development](contribute/developer-guide.md).
67

68
When you're ready to contribute, it's time to [Create a pull request](/contribute/create-pull-request.md).
69

70
#### Contributor License Agreement (CLA)
71

72
Before we can accept your pull request, you need to [sign our CLA](https://grafana.com/docs/grafana/latest/developers/cla/). If you haven't, our CLA assistant prompts you to when you create your pull request.
73

74
## Where do I go from here?
75

Marcus Olsson's avatar
Marcus Olsson committed
76
- Set up your [development environment](contribute/developer-guide.md).
77
- Learn how to [contribute documentation](contribute/documentation.md).
78
- Get started [developing plugins](https://grafana.com/docs/grafana/latest/developers/plugins/) for Grafana.
79
- Look through the resources in the [contribute](https://github.com/grafana/grafana/tree/main/contribute) folder.