Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributing guideline #192

Merged
merged 1 commit into from
Sep 23, 2022
Merged

Add contributing guideline #192

merged 1 commit into from
Sep 23, 2022

Conversation

sunker
Copy link
Collaborator

@sunker sunker commented Sep 20, 2022

This PR adds a contributing guideline with details about how to generate the golden files.

Related to #184

Fixes #183

cc @nekketsuuu

@sunker sunker requested a review from a team as a code owner September 20, 2022 14:15
@github-actions
Copy link

Backend code coverage report for PR #192
No changes

@github-actions
Copy link

Frontend code coverage report for PR #192
No changes

Copy link
Contributor

@iwysiu iwysiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm with one fix.
Also we can add the development with local grafana section from redshift if we think it'll be useful.

CONTRIBUTING.md Show resolved Hide resolved
Comment on lines -19 to -22
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/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This information will be removed by your changes. Is that intentional?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we (this was done in a mob session last week) were trying to streamline the readme with the other plugins we have.

@sunker sunker merged commit 4d8218d into main Sep 23, 2022
@sunker sunker deleted the golden-files-docs branch September 23, 2022 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cannot regenerate golden files for executor_test.go from scratch
3 participants