|
| 1 | +# Contributing Guide |
| 2 | + |
| 3 | +Thank you for taking the time to contribute! :tada::+1: |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +--- |
| 8 | +:star: If you already here and love the project, please make sure to press the Star button. :star: |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +## Table of Contents |
| 13 | + |
| 14 | +[How can I contribute?](#how-can-i-contribute) |
| 15 | + |
| 16 | +- [Reporting Bugs](#reporting-bugs) |
| 17 | +- [Suggesting Enhancements / Feature Requests](#suggesting-enhancements--feature-requests) |
| 18 | +- [Pull Requests](#pull-requests) |
| 19 | +- [Documentation](#documentation) |
| 20 | +- Design? |
| 21 | + |
| 22 | +[Additional Notes](#additional-notes) |
| 23 | + |
| 24 | +- [Release Method](#release-method) |
| 25 | +- [Code of Conduct](#code-of-conduct) |
| 26 | + |
| 27 | +## How can I contribute? |
| 28 | + |
| 29 | +### Reporting Bugs |
| 30 | + |
| 31 | +When creating a new bug report, please make sure to: |
| 32 | + |
| 33 | +- 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. |
| 34 | +- If you still decide to open an issue, please review the template and guidelines and include as much details as possible. |
| 35 | + |
| 36 | +### Suggesting Enhancements / Feature Requests |
| 37 | + |
| 38 | +If you would like to suggest an enhancement or ask for a new feature: |
| 39 | + |
| 40 | +- 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. |
| 41 | +- 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*. |
| 42 | + |
| 43 | +### Pull Requests |
| 44 | + |
| 45 | +- **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. |
| 46 | +- Include screenshots and animated GIFs in your pull request whenever possible. |
| 47 | +- Please add [documentation](#documentation) for new features or changes in functionality along with the code. |
| 48 | + |
| 49 | +### Documentation |
| 50 | + |
| 51 | +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. |
| 52 | + |
| 53 | +## Additional Notes |
| 54 | + |
| 55 | +### Release Method |
| 56 | + |
| 57 | +We publish a stable release every ~3-4 months, although the goal is to get to a stable release every month. |
| 58 | + |
| 59 | +## Code of Conduct |
| 60 | + |
| 61 | +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 abuse@doit-intl.com |
0 commit comments