Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.25 KB

Contributing

If you want to contribute to the plugin, you can contribute in one of the following ways

  • Test different APIs and create bugs if not working as expected
  • If you find any interesting APIs, showcase how you are using the API with Infinity datasource so that other community members will get benefit out of it.

Setting up locally for development

You need following tools in your local machine for development

  • NodeJS v14.0+
  • Go 1.16
  • Mage

Once you clone the repo locally in the grafana's plugin folder. Do the following steps

  • yarn - This will install the frontend dependencies. Do this once
  • mage -v - This will help to build the backend part of the plugin. Do this once if you are contributing only the frontend. There is no significant code is in the backend. So no much changes expected
  • yarn watch - For continuously watching the front-end changes and build
  • yarn test - To make sure all the existing tests passed
  • cd website & yarn dev - To build and see the changes of docs website
  • cd website & yarn build - To build the docs website