grafana/CONTRIBUTING.md

Contribute to Grafana

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.

This document is a guide to help you through the process of contributing to Grafana. Be sure to check out the Grafana Champions program as you start to contribute. It’s designed to recognize and empower individuals who are actively contributing to the growth and success of the Grafana ecosystem.

Whether you're a new contributor or a seasoned veteran, we hope these resources help you connect with the community.

Interact and be heard

• Forums: Do you have a problem, question, or curiosity? Visit our forums for a reservoir of knowledge, submit your own questions and answers!
• Meetups: Craving in-person connections without the long journeys? Join your local Grafana & Friends meetup group!
• Community Slack: Eager for real-time connections with fellow users? Begin a conversation on Slack.

Learn

• YouTube: From getting started to exploring newer projects like Pyroscope and Beyla, the Grafana YouTube channel has what you need to get started!
• Meetups: Join a group near you to learn from local experts and ask questions in real time.

Make technical contributions

• You can make technical contributions with or without code. Scroll down to see how!

Share your story

• Meetups and blogs: We’d love to feature your OSS Grafana Labs use case or story at an upcoming Grafana & Friends meetup or on the Grafana blog! Submit your idea here, and we’ll connect with you on next steps if accepted.

Choose the right channel

Use the right place to ask questions, report problems, and propose changes.

• GitHub issues and pull requests: Use for reproducible bugs in core Grafana and maintained plugins, small and actionable feature requests, and code or docs changes via pull requests. Avoid general “how do I” questions. For security issues, follow the security policy.
• Grafana community forums: Use for questions, troubleshooting, best practices, plugin development Q&A, and early idea discussion. Forums create a searchable public knowledge base that helps others with the same problems and questions. Start here if you are unsure: Grafana community forums.
• Grafana Community Slack: Use for quick, time-sensitive chats and networking. Do not rely on Slack for complex troubleshooting or decisions. Share outcomes back to a forum topic or GitHub issue/PR to keep a public record: Grafana Community Slack.
• Not sure where to start? Start with a forum topic. Maintainers and community members will redirect you if a GitHub issue or pull request is more appropriate.

Make technical contributions

We welcome your technical contributions! You can contribute in several ways:

Contribute Code to Grafana

What you will need:

• Follow our developer guide to set up your environment.
• Adhere to our frontend and backend style guides.
• Write or update tests (testing guide).

Step-by-step:

1. Browse all issues to find something to work on. You can also filter by help wanted.
2. Prepare a clear, descriptive pull request (how-to guide).
3. Ensure you include and run the appropriate tests as part of your pull request.
4. Commit and push your changes. If you encounter merge conflicts, you may rebase your branch onto the main branch.

Develop a Plugin

Grafana plugins let you extend the platform with new data sources, panels, and more. This is a great way to share your ideas and make a real impact on the Grafana ecosystem.

Step-by-step:

1. Read the plugin development guide to choose your plugin type and set up your environment.
2. Scaffold your plugin using the recommended tools.
3. Develop and test your plugin locally.
4. Follow best practices for code style, testing, and documentation.
5. Publish your plugin or submit it for review as described in the guide.

Contribute without code

You can help even if you don't write code:

• Report a bug with the bug report template and include steps to reproduce.
• Submit a feature request to propose improvements.
• Improve our docs with the documentation contribution guide.
• Help with issue triage by reviewing, labeling, and clarifying open issues.
• Report security vulnerabilities following our security policy.

Please note: We do not currently accept contributions for translations. Please do not submit pull requests translating grafana.json files - they will be rejected. We do accept contributions to mark up phrases for translation. See Internationalization.

Reporting issues

Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the existing issues for similar issues.

Report a bug by submitting a bug report. Make sure that you provide as much information as possible on how to reproduce the bug.

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 dashboard related issues:

• Dashboard JSON can be found in the dashboard settings JSON model view. You can send the panel JSON model to Grafana Labs Technical Support and request help with troubleshooting your issue.

For authentication and alerting, Grafana server logs are useful.

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.

Security issues

If you believe you've found a security vulnerability, please read our security policy for more details on reporting.

Suggest features

If you have an idea of how to improve Grafana, submit a feature request.

We want to make Grafana accessible to even more people. Submit an accessibility issue to help us understand what we can improve.

Write documentation

To edit or write technical content, refer to Contribute to our documentation. We welcome your expertise and input as our body of technical content grows.

Contributor License Agreement (CLA)

Before we can accept your pull request, you need to sign our CLA. If you haven't, our CLA assistant prompts you to when you create your pull request.

Where do I go from here?

• Set up your development environment.
• Learn how to contribute to our documentation.
• Get started developing plugins for Grafana.
• Look through the resources in the contribute folder.