Skip to content

Commit 6a0528a

Browse files
committed
Imporove contributing guide.
1 parent 4dc4070 commit 6a0528a

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

CONTRIBUTING.md

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# Contributing to QuestDB Datasource
22

33
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.
4-
Feel free to [browse the open issues](https://github.com/questdb/questdb-grafana-datasource/issues).
5-
If you want more straightforward tasks to complete, [we have some](https://github.com/questdb/grafana-questdb-datasource/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
6-
For more details about how you can help, please take a look at [Grafana’s Contributing Guide](https://github.com/questdb/grafana-questdb-datasource/blob/main/CONTRIBUTING.md).
4+
Feel free to [browse the open issues](https://github.com/questdb/questdb-grafana-datasource/issues).
75

86
## Development setup
97

108
### Getting started
119

12-
Clone this repository into your local environment. The frontend code lives in the `src` folder, alongside the [plugin.json file](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/). The backend Go code is in the `pkg` folder. To build this plugin refer to [Build a plugin](https://grafana.com/docs/grafana/latest/developers/plugins/)
10+
Clone this repository into your local environment. The frontend code lives in the `src` folder, alongside the [plugin.json file](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/).
11+
The backend Go code is in the `pkg` folder. To build this plugin refer to [plugin tools(https://grafana.com/developers/plugin-tools).
1312

1413
### Running the development version
1514

16-
Before you can set up the plugin, you need to set up your environment by following [Set up your environment](https://grafana.com/tutorials/build-a-data-source-backend-plugin/#set-up-your-environment).
15+
Before you can set up the plugin, you need to set up your environment by installing:
16+
- [golang 1.21+](https://go.dev/doc/install)
17+
- [nodejs 18+](https://nodejs.org/en/download)
18+
- [mage](https://github.com/magefile/mage)
19+
- [yarn](https://classic.yarnpkg.com/en/docs/install)
1720

1821
#### Compiling the backend
1922

@@ -24,6 +27,12 @@ mage test # run all Go test cases
2427
mage build:backend && mage reloadPlugin # builds and reloads the plugin in Grafana
2528
```
2629

30+
If host operating system is different from one used in grafana docker image use the following instead:
31+
32+
```sh
33+
mage -v buildAll
34+
```
35+
2736
#### Compiling the frontend
2837

2938
You can build and test the frontend by using `yarn`:
@@ -39,17 +48,10 @@ You can also have `yarn` watch for changes and automatically recompile them:
3948
yarn watch
4049
```
4150

42-
## Create a pull request
51+
### Starting docker containers
4352

44-
Once you are ready to make a pull request, please read and follow [Create a pull request](https://github.com/grafana/grafana/blob/master/contribute/create-pull-request.md).
53+
You can start grafana and questdb containers with:
4554

46-
## Build a release for the QuestDB data source plugin
47-
48-
You need to have commit rights to the GitHub repository to publish a release.
49-
50-
1. Update the version number in the `package.json` file.
51-
2. Update the `CHANGELOG.md` by copy and pasting the relevant PRs
52-
from [GitHub's Release drafter interface](https://github.com/questdb/grafana-questdb-datasource/releases/new) or by
53-
running `npm run generate-release-notes`.
54-
3. PR the changes.
55-
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)
55+
```sh
56+
docker-compose up
57+
```

0 commit comments

Comments
 (0)