Вклад в Grafana
На этой странице собраны материалы для разработчиков, которые хотят внести вклад в экосистему программного обеспечения Grafana или создавать плагины для Grafana.
Общение с Grafana
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 long troubleshooting or decisions. Share outcomes back to a forum topic or GitHub issue/PR to keep a public record: Grafana Community Slack.
Note
Not sure where to start? Open a new topic in the forum! Maintainers and community members will redirect you if a GitHub issue or pull request is more appropriate.
Технический вклад
Выберите, как вы хотите внести вклад в Grafana: кодом, плагинами или поддержкой сообщества.
Вклад в код Grafana
- Участие в разработке Grafana знакомит с процессом внесения вклада и ресурсами сообщества.
- Руководство разработчика показывает, как настроить окружение и запустить Grafana в режиме разработки.
- Руководства по архитектуре объясняют внутреннюю архитектуру Grafana.
- Создание pull request пошагово проведёт вас через подготовку понятного и информативного pull request.
- Просмотрите все задачи, чтобы найти подходящую первую задачу. Также можно отфильтровать по метке help wanted.
- Используйте REST API для программного взаимодействия с бэкендом Grafana.
Разработка плагина
- Прочитайте руководство по разработке плагинов, чтобы выбрать тип плагина, создать каркас проекта и вести разработку локально.
Вклад без кода
- Сообщите об ошибке с помощью шаблона отчёта об ошибке и приложите шаги воспроизведения.
- Отправьте запрос на новую функцию, чтобы предложить улучшения.
- Улучшайте нашу документацию с помощью руководства по вкладу в документацию.
- Помогите с разбором задач (triage), просматривая, помечая метками и уточняя открытые задачи.
- Сообщайте об уязвимостях безопасности в соответствии с нашей политикой безопасности.
Лучшие практики и стиль
Наши руководства по стилю определяют стиль Grafana для фронтенда, бэкенда, документации и не только, включая лучшие практики. Пожалуйста, прочитайте их, прежде чем приступать к правке или написанию кода!
-
Руководство по стилю бэкенда объясняет, как мы хотим писать код на Go в дальнейшем.
-
Руководство по стилю документации применяется ко всей документации, создаваемой для продуктов Grafana.
-
Фреймворк end-to-end тестирования содержит рекомендации для e2e-тестов Grafana.
-
Руководство по стилю фронтенда содержит правила и рекомендации по разработке на React для Grafana.
-
Фреймворк Redux объясняет, как Grafana работает с шаблонным кодом Redux.
-
Стилизация Grafana подробно описывает стилизацию React-компонентов с помощью Emotion.
-
Темизация Grafana объясняет, как использовать темы и ThemeContext в коде Grafana.