|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for taking an interest in the project! We welcome all manner of contributions that are within the bounds of the project's [code of conduct](CODE_OF_CONDUCT.md). |
| 4 | + |
| 5 | +#### **Did you find a bug?** |
| 6 | + |
| 7 | +* **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy](SECURITY.md). |
| 8 | + |
| 9 | +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/kubernetes-monitoring/kubernetes-mixin/issues). |
| 10 | + |
| 11 | +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/kubernetes-monitoring/kubernetes-mixin/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **`jsonnet` snippet**, if applicable, as well as an optional **visual sample** demonstrating the expected behavior that is not occurring. |
| 12 | + |
| 13 | +* Whenever possible, use the relevant bug report templates to create the issue. |
| 14 | + |
| 15 | +#### **Did you write a patch that fixes a bug?** |
| 16 | + |
| 17 | +* Open a new GitHub pull request with the patch. |
| 18 | + |
| 19 | +* Ensure the PR description describes the problem **and** solution. Include the relevant issue number if applicable. |
| 20 | + |
| 21 | +* Before submitting, please make sure the pull request template is filled out correctly. |
| 22 | + |
| 23 | +#### **Do you intend to add a new feature or change an existing one?** |
| 24 | + |
| 25 | +* Suggest your change in [#monitoring-mixins](https://kubernetes.slack.com/archives/CAX9GU941) and start writing code. While doing so, please reflect on: |
| 26 | + * Is your feature request related to a problem? Please describe the necessity for the change. |
| 27 | + * Describe the solution you're proposing. Please provide any relevant context. |
| 28 | + * Add any other context (for example, any workarounds, code snippets, visual aids, etc.), if applicable. |
| 29 | + |
| 30 | +* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes. |
| 31 | + |
| 32 | +#### **Do you have questions about the source code?** |
| 33 | + |
| 34 | +* Ask any question about how to use the `kubernetes-mixin` project in the [#monitoring-mixins](https://kubernetes.slack.com/archives/CAX9GU941). |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +`kubernetes-mixin` is a volunteer effort. We encourage you to pitch in and join [the team](https://github.com/kubernetes-monitoring/kubernetes-mixin/graphs/contributors)! |
0 commit comments