|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +:+1::tada: First off, we appreciate you taking the time to contribute! THANK YOU! :tada::+1: |
| 4 | + |
| 5 | +We put together the handy guide below to help you get support for your work. Read on! |
| 6 | + |
| 7 | +## I Just Want to Ask the Maintainers a Question |
| 8 | + |
| 9 | +The [Linode Community](https://www.linode.com/community/questions/) is a great place to get additional support. |
| 10 | + |
| 11 | +## How Do I Submit A (Good) Bug Report or Feature Request |
| 12 | + |
| 13 | +Please open a [GitHub issue](../../issues/new/choose) to report bugs or suggest features. |
| 14 | + |
| 15 | +Please accurately fill out the appropriate GitHub issue form. |
| 16 | + |
| 17 | +When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first. |
| 18 | + |
| 19 | +Detailed bug reports and requests are easier for us to work with. Please include the following in your issue: |
| 20 | + |
| 21 | +* A reproducible test case or series of steps |
| 22 | +* The version of our code being used |
| 23 | +* Any modifications you've made, relevant to the bug |
| 24 | +* Anything unusual about your environment or deployment |
| 25 | +* Screenshots and code samples where illustrative and helpful |
| 26 | + |
| 27 | +## How to Open a Pull Request |
| 28 | + |
| 29 | +We follow the [fork and pull model](https://opensource.guide/how-to-contribute/#opening-a-pull-request) for open source contributions. |
| 30 | + |
| 31 | +Tips for a faster merge: |
| 32 | +* address one feature or bug per pull request. |
| 33 | +* large formatting changes make it hard for us to focus on your work. |
| 34 | +* follow language coding conventions. |
| 35 | +* make sure that tests pass. |
| 36 | +* make sure your commits are atomic, [addressing one change per commit](https://chris.beams.io/posts/git-commit/). |
| 37 | +* add tests! |
| 38 | + |
| 39 | +## Code of Conduct |
| 40 | + |
| 41 | +This project follows the [Linode Community Code of Conduct](https://www.linode.com/community/questions/conduct). |
| 42 | + |
| 43 | +## Vulnerability Reporting |
| 44 | + |
| 45 | +If you discover a potential security issue in this project we ask that you notify Linode Security via our [vulnerability reporting process](https://hackerone.com/linode). Please do **not** create a public github issue. |
| 46 | + |
| 47 | +## Licensing |
| 48 | + |
| 49 | +See the [LICENSE file](/LICENSE) for our project's licensing. |
0 commit comments