This repository has been archived by the owner on Dec 11, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:doitintl/bigquery-grafana
- Loading branch information
Showing
2 changed files
with
61 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Contributing Guide | ||
|
||
Thank you for taking the time to contribute! :tada::+1: | ||
|
||
The following is a set of guidelines for contributing to BigQuery Plugin for Grafana. These are guidelines, not rules, please use your best judgement and feel free to propose changes to this document in a pull request. | ||
|
||
--- | ||
:star: If you already here and love the project, please make sure to press the Star button. :star: | ||
|
||
--- | ||
|
||
## Table of Contents | ||
|
||
[How can I contribute?](#how-can-i-contribute) | ||
|
||
- [Reporting Bugs](#reporting-bugs) | ||
- [Suggesting Enhancements / Feature Requests](#suggesting-enhancements--feature-requests) | ||
- [Pull Requests](#pull-requests) | ||
- [Documentation](#documentation) | ||
- Design? | ||
|
||
[Additional Notes](#additional-notes) | ||
|
||
- [Release Method](#release-method) | ||
- [Code of Conduct](#code-of-conduct) | ||
|
||
## How can I contribute? | ||
|
||
### Reporting Bugs | ||
|
||
When creating a new bug report, please make sure to: | ||
|
||
- Search for existing issues first. If you find a previous report of your issue, please update the existing issue with additional information instead of creating a new one. | ||
- If you still decide to open an issue, please review the template and guidelines and include as much details as possible. | ||
|
||
### Suggesting Enhancements / Feature Requests | ||
|
||
If you would like to suggest an enhancement or ask for a new feature: | ||
|
||
- Please check [the forum](https://feedback.doit-intl.com/forums/933776-grafana-bigquery-plugin) for existing threads about what you want to suggest/ask. If there is, feel free to upvote it to signal interest or add your comments. | ||
- If there is no open thread, you're welcome to start one to have a discussion about what you want to suggest. Try to provide as much details and context as possible and include information about *the problem you want to solve* rather only *your proposed solution*. | ||
|
||
### Pull Requests | ||
|
||
- **Code contributions are welcomed**. For big changes or significant features, it's usually better to reach out first and discuss what you want to implement and how (we recommend reading: [Pull Request First](https://medium.com/practical-blend/pull-request-first-f6bb667a9b6#.ozlqxvj36)). This to make sure that what you want to implement is aligned with our goals for the project and that no one else is already working on it. | ||
- Include screenshots and animated GIFs in your pull request whenever possible. | ||
- Please add [documentation](#documentation) for new features or changes in functionality along with the code. | ||
|
||
### Documentation | ||
|
||
The project's documentation can be found at [https://github.com/doitintl/bigquery-grafana/blob/master/README.md). To contribute edits, you can use GitHub's interface. Click the "Edit on GitHub" link on the documentation page to quickly open the edit interface. | ||
|
||
## Additional Notes | ||
|
||
### Release Method | ||
|
||
We publish a stable release every ~3-4 months, although the goal is to get to a stable release every month. | ||
|
||
## Code of Conduct | ||
|
||
This project adheres to the Contributor Covenant [code of conduct](https://github.com/doitintl/bigquery-grafana/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters