add contributing docs (#192)

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Building and releasing
+
+## How to build the Timestream data source plugin locally
+
+## Dependencies
+
+Make sure you have the following dependencies installed first:
+
+- [Git](https://git-scm.com/)
+- [Go](https://golang.org/dl/) (see [go.mod](../go.mod#L3) for minimum required version)
+- [Mage](https://magefile.org/)
+- [Node.js (Long Term Support)](https://nodejs.org)
+- [Yarn](https://yarnpkg.com)
+
+## Frontend
+
+1. Install dependencies
+
+   ```bash
+   yarn install --pure-lockfile
+   ```
+
+2. Build plugin in development mode or run in watch mode
+
+   ```bash
+   yarn dev
+   ```
+
+   or
+
+   ```bash
+   yarn watch
+   ```
+
+3. Build plugin in production mode
+
+   ```bash
+   yarn build
+   ```
+
+## Backend
+
+1. Build the backend binaries
+
+   ```bash
+   build:backend
+   ```
+
+### Golden files
+
+Golden files check that data frames are being generated correctly based on the Timestream API response. They have two parts, the json files represent the raw API response and the golden files represent the expected data frame. Both are generated in executor_test.go.
+
+#### Re-generating json API response
+
+> **Note:** Only members of the Grafana team can re-generate these files. If you need help with this, ping the @grafana/aws-plugins team on GitHub and they will help out.
+
+1. Make sure to comment out the [t.Skip("Integration Test")](https://github.com/grafana/timestream-datasource/blob/5b3f07edb13cb3e3bbeeca284f5b9228a30de451/pkg/timestream/executor_test.go#L64) line in the executor_test.go file.
+2. Run the `TestGenerateTestData`. This should regenerate the json files.
+3. Uncomment the `t.Skip("Integration Test")` again.
+
+#### Re-generating golden files
+
+1. Change the last argument in the [CheckGoldenDataResponse](https://github.com/grafana/timestream-datasource/blob/5b3f07edb13cb3e3bbeeca284f5b9228a30de451/pkg/timestream/executor_test.go#L40) call to true. This will re-generate the golden files.
+2. Run the test, and then undo the change from step 1.
+3. Re-run the test and they should now pass.
+
+## Build a release for the Timestream data source plugin
+
+### Pre-requisites
+
+Before doing a release, make sure that the GitHub repository is configured with a `GRAFANA_API_KEY` to be able to sign the plugin and that the Golang and Node versions in the [release.yaml](./.github/workflows/release.yaml) workflow are correct.
+
+Also, make sure that the path to the plugin validator in the [release.yaml](./.github/workflows/release.yaml#L122) is correct (this fixes the error `pushd: ./plugin-validator/cmd/plugincheck: No such file or directory`):
+
+```
+pushd ./plugin-validator/pkg/cmd/plugincheck`
+```
+
+### Release
+
+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` with the changes contained in the release.
+3. Commit the changes to master and push to GitHub.
+4. Follow the Drone release process that you can find [here](https://github.com/grafana/integrations-team/wiki/Plugin-Release-Process#drone-release-process)

README.md

@@ -2,24 +2,14 @@
 
 The Timestream datasource plugin provides a support for [Amazon Timestream](https://aws.amazon.com/timestream/). Add it as a data source, then you are ready to build dashboards using timestream query results
 
-Please add feedback to the [issues](https://github.com/grafana/timestream-datasource/issues) folder, and we will follow up shortly.  Be sure to include version information for both grafana and the installed plugin.
+Please add feedback to the [issues](https://github.com/grafana/timestream-datasource/issues) folder, and we will follow up shortly. Be sure to include version information for both grafana and the installed plugin.
 
 The production plugins can be downloaded from [the Timestream plugin page](https://grafana.com/grafana/plugins/grafana-timestream-datasource/).
 
 For configuration options, see: [src/README.md](src/README.md)
 
+## Contributing
 
-## Developer Guide
-
-
-You will need to install [Node.js](https://nodejs.org/en/), [Yarn](https://yarnpkg.com/), [Go](https://golang.org/), and [Mage](https://magefile.org/) first.
-1. `yarn install --frozen-lockfile`
-1. `yarn dev` — will build the frontend changes
-1. `mage build:backend` — will build the backend changes
-1. (Optional) `mage -v buildAll` — this is optional if you need backend plugins for other platforms
-1. The compiled plugin should be in `dist/` directory.
-1. Run Grafana in [development](https://grafana.com/docs/grafana/latest/administration/configuration/#app_mode) mode, or configure Grafana to [load the unsigned plugin](https://grafana.com/docs/grafana/latest/plugins/plugin-signatures/#allow-unsigned-plugins).
-1. You can install by following the [install Grafana plugins docs page](https://grafana.com/docs/grafana/latest/plugins/installation/).
-
-For more information, please consult the [build a plugin docs page](https://grafana.com/docs/grafana/latest/developers/plugins/).
+If you're interested in contributing to the Timestream plugin:
 
+- Start by reading the [Contributing guide](https://github.com/grafana/timestream-datasource/blob/main/CONTRIBUTING.md).