|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -Thank you for your interest in contributing to the plugin! 🙏 |
| 3 | +Thank you for your interest in contributing to the plugin! 🙏 This document explains the ways you can contribute the project! |
| 4 | + |
| 5 | +- How do I ... |
| 6 | + - [Contribute code](#contribute-code) |
| 7 | + - [Contribute documentation](#contribute-documentation) |
| 8 | + - [Set up the project](#set-up-the-project) |
| 9 | + |
| 10 | +If you get stuck along the way, feel free to [ask for help](https://github.com/marcusolsson/grafana-json-datasource/discussions/new?category=q-a). |
4 | 11 |
|
5 | 12 | ## Contribute code
|
6 | 13 |
|
| 14 | +To contribute code: |
| 15 | + |
| 16 | +1. Check if there's an already existing issue that describes the reason or motivation behind your pull request. |
| 17 | +2. If there are no issues describing what you want to do, go ahead and [create one](https://github.com/marcusolsson/grafana-json-datasource/issues/new). By creating an issue before you start working on a fix, you can increase the chance of your pull request getting accepted! 💪 |
| 18 | +3. Include any [documentation](contribute-documentation) that your changes might need. |
| 19 | +4. Write or update tests to verify that your changes work as expected. |
| 20 | +5. Now you're ready to [open a pull request](https://github.com/marcusolsson/grafana-json-datasource/compare)! |
| 21 | +6. In the description for your pull request, add a line that says `Fixes #123`, where `123` is the number of the issue the pull request fixes. |
| 22 | + |
| 23 | +After you've created the pull request: |
| 24 | + |
| 25 | +- If the maintainer asks for any changes, edit your changes, push, and ask for another review. |
| 26 | +- If the maintainer decides to pass on your pull request, they will thank you for the contribution and explain why they won't be accepting the changes. |
| 27 | +- If your pull request gets accepted, it'll be merged into the main branch soon after. Your contribution will be available in the next release! 🎉 |
| 28 | + |
| 29 | +## Contribute documentation |
| 30 | + |
| 31 | +This plugin uses [Docusaurus](https://docusaurus.io/) to build the [documentation](https://marcus.se.net/grafana-json-datasource). |
| 32 | + |
| 33 | +For more information about writing documentation using Docusaurus, refer to the [Docusaurus documentation](https://docusaurus.io/docs/). |
| 34 | + |
| 35 | +The individual documentation pages are written in Markdown. You can find them under [website/docs](website/docs). |
| 36 | + |
| 37 | +To preview the documentation site on your local machine, run the following in your terminal: |
| 38 | + |
| 39 | +```bash |
| 40 | +cd website/docs |
| 41 | +yarn start |
| 42 | +``` |
| 43 | + |
| 44 | +## Set up the project |
| 45 | + |
7 | 46 | ### Set up the plugin
|
8 | 47 |
|
9 | 48 | This project uses GitHub Pull Requests to manage contributions. If this is your first time contributing to a project on GitHub, you should first learn how to [fork a project and make a pull request](https://guides.github.com/activities/forking/).
|
@@ -62,18 +101,3 @@ docker run --rm \
|
62 | 101 | -p 3000:3000 \
|
63 | 102 | grafana/grafana:8.0.0-beta2
|
64 | 103 | ```
|
65 |
| - |
66 |
| -## Contribute documentation |
67 |
| - |
68 |
| -This plugin uses [Docusaurus](https://docusaurus.io/) to build the [documentation](https://marcus.se.net/grafana-json-datasource). |
69 |
| - |
70 |
| -For more information about writing documentation using Docusaurus, refer to the [Docusaurus documentation](https://docusaurus.io/docs/). |
71 |
| - |
72 |
| -The individual documentation pages are written in Markdown. You can find them under [website/docs](website/docs). |
73 |
| - |
74 |
| -To preview the documentation site on your local machine, run the following in your terminal: |
75 |
| - |
76 |
| -```bash |
77 |
| -cd website/docs |
78 |
| -yarn start |
79 |
| -``` |
|
0 commit comments