Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (37 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 2.9 KB

Contributing to ClickHouse Datasource

Thank you for your interest in contributing to this repository. We are glad you want to help us to improve the project and join our community. Feel free to browse the open issues. If you want more straightforward tasks to complete, we have some. For more details about how you can help, please take a look at Grafana’s Contributing Guide.

Development setup

Getting started

Clone this repository into your local environment. The frontend code lives in the src folder, alongside the plugin.json file. The backend Go code is in the pkg folder. To build this plugin refer to Build a plugin

Running the development version

Before you can set up the plugin, you need to set up your environment by following Set up your environment.

Compiling the backend

You can use mage to compile and test the Go backend.

mage test # run all Go test cases
mage build:backend && mage reloadPlugin # builds and reloads the plugin in Grafana

Compiling the frontend

You can build and test the frontend by using npm:

npm run test # run all test cases
npm run dev # builds and puts the output at ./dist

You can also have npm watch for changes and automatically recompile them:

npm run watch

Running E2E tests locally

  1. Install K6
  2. Run npm run test:e2e:local

Create a pull request

Run npm run lint and npm run prettier:check to check for any style errors. Any PRs that have linter or prettier errors will not pass pull request CI checks. Run npm run lint:fix && npm run prettier:write to automatically fix linter or prettier errors.

Once you are ready to make a pull request, please read and follow Create a pull request.

Build a release for the ClickHouse data source plugin

You need to have commit rights to the GitHub repository to publish a release.

  1. Update the version number in the package.json file.
  2. Update the CHANGELOG.md by copy and pasting the relevant PRs from GitHub's Release drafter interface or by running npm run generate-release-notes.
  3. PR the changes.
  4. Once merged, follow the Drone release process that you can find [here](https://github.com/grafana/integrations-team/wiki/Plugin-Release-Process#drone-release-proces