2fb301ccaf
* Move style guides into contribute directory * Move contribution guides into contribute directory * Refactor CONTRIBUTING.md * Clean up docs/README.md * Update reference to style guide and minor formatting fixes * Apply suggestions from code review Co-Authored-By: gotjosh <josue.abreu@gmail.com> * Update CONTRIBUTING.md Co-Authored-By: gotjosh <josue.abreu@gmail.com>
3.3 KiB
Contributing 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.
Become a contributor
You can contribute to Grafana in several ways. Here are some examples:
- 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.
For more ways to contribute, check out the Open Source Guides.
Report bugs
Report a bug by submitting a bug report. Make sure that you provide as much information as possible on how to reproduce the bug.
Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the existing issues for similar issues.
Security issues
If you believe you've found a security vulnerability, please read our security policy for more details.
Suggest enhancements
If you have an idea of how to improve Grafana, submit an enhancement request.
Your first contribution
Unsure where to begin contributing to Grafana? Start by browsing issues labeled beginner friendly or help wanted.
- Beginner-friendly issues are generally straightforward to complete.
- Help wanted issues are problems we would like the community to help us with regardless of complexity.
If you're looking to make a code change, see how to set up your environment for local development.
When you're ready to contribute, it's time to Create a pull request.
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.
Community
- Follow @grafana on Twitter
- Read and subscribe to the Grafana blog
- If you have a specific question, check out our discussion forums.
- For general discussions, join us on the official Slack.
Where do I go from here?
- Set up your development environment.
- Learn how to contribute documentation.
- Get started developing plugins for Grafana.