Skip to content
This repository was archived by the owner on Dec 11, 2022. It is now read-only.

Commit 06b0536

Browse files
authored
Create CONTRIBUTING.md
1 parent fd3ac11 commit 06b0536

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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+
13+
## Table of Contents
14+
15+
[How can I contribute?](#how-can-i-contribute)
16+
17+
- [Reporting Bugs](#reporting-bugs)
18+
- [Suggesting Enhancements / Feature Requests](#suggesting-enhancements--feature-requests)
19+
- [Pull Requests](#pull-requests)
20+
- [Documentation](#documentation)
21+
- Design?
22+
23+
[Additional Notes](#additional-notes)
24+
25+
- [Release Method](#release-method)
26+
- [Code of Conduct](#code-of-conduct)
27+
28+
## How can I contribute?
29+
30+
### Reporting Bugs
31+
32+
When creating a new bug report, please make sure to:
33+
34+
- 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.
35+
- If you still decide to open an issue, please review the template and guidelines and include as much details as possible.
36+
37+
### Suggesting Enhancements / Feature Requests
38+
39+
If you would like to suggest an enhancement or ask for a new feature:
40+
41+
- 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.
42+
- 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*.
43+
44+
### Pull Requests
45+
46+
- **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.
47+
- Include screenshots and animated GIFs in your pull request whenever possible.
48+
- Please add [documentation](#documentation) for new features or changes in functionality along with the code.
49+
- Please follow existing code style:
50+
- Python: we use [Black](https://github.com/psf/black) to auto format the code.
51+
- Javascript: we use [Prettier](https://github.com/prettier/prettier) to auto-format the code.
52+
53+
### Documentation
54+
55+
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.
56+
57+
## Additional Notes
58+
59+
### Release Method
60+
61+
We publish a stable release every ~3-4 months, although the goal is to get to a stable release every month.
62+
63+
## Code of Conduct
64+
65+
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]

0 commit comments

Comments
 (0)