|
| 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](https://guides.github.com/features/issues/) to report bugs or suggest features. |
| 14 | + |
| 15 | +When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first. |
| 16 | + |
| 17 | +Detailed bug reports and requests are easier for us to work with. Please include the following in your issue: |
| 18 | + |
| 19 | +* A reproducible test case or series of steps |
| 20 | +* The version of our code being used |
| 21 | +* Any modifications you've made, relevant to the bug |
| 22 | +* Anything unusual about your environment or deployment |
| 23 | +* Screenshots and code samples where illustrative and helpful |
| 24 | + |
| 25 | +## How to Open a Pull Request |
| 26 | + |
| 27 | +We follow the [fork and pull model](https://opensource.guide/how-to-contribute/#opening-a-pull-request) for open source contributions. |
| 28 | + |
| 29 | +Tips for a faster merge: |
| 30 | + * address one feature or bug per pull request. |
| 31 | + * large formatting changes make it hard for us to focus on your work. |
| 32 | + * follow language coding conventions. |
| 33 | + * make sure that tests pass. |
| 34 | + * make sure your commits are atomic, [addressing one change per commit](https://chris.beams.io/posts/git-commit/). |
| 35 | + * add tests! |
| 36 | + |
| 37 | +## Contributing a Patch |
| 38 | + |
| 39 | +1. Fork the desired repo, develop and test your code changes. |
| 40 | + 1. See the [Development Guide](https://linode.github.io/cluster-api-provider-linode/developers/development.html) for more instructions on setting up your environment and testing changes locally. |
| 41 | +2. Submit a pull request. |
| 42 | + 1. All PRs should be labeled with one of the following kinds |
| 43 | + - `/kind feature` for PRs related to adding new features/tests |
| 44 | + - `/kind bug` for PRs related to bug fixes and patches |
| 45 | + - `/kind api-change` for PRs related to adding, removing, or otherwise changing an API |
| 46 | + - `/kind cleanup` for PRs related to code refactoring and cleanup |
| 47 | + - `/kind deprecation` for PRs related to a feature/enhancement marked for deprecation. |
| 48 | + - `/kind design` for PRs related to design proposals |
| 49 | + - `/kind documentation` for PRs related to documentation |
| 50 | + - `/kind other` for PRs related to updating dependencies, minor changes or other |
| 51 | + 2. All code changes must be covered by unit tests and E2E tests. |
| 52 | + 3. All new features should come with user documentation. |
| 53 | +3. Ensure that commit message(s) are be meaningful and commit history is readable. |
| 54 | + |
| 55 | +All changes must be code reviewed. Coding conventions and standards are explained in the official [developer docs](https://github.com/kubernetes/community/tree/master/contributors/devel). Expect reviewers to request that you avoid common [go style mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs. |
| 56 | + |
| 57 | +In case you want to run our E2E tests locally, please refer to the [E2E Testing](https://linode.github.io/cluster-api-provider-linode/developers/development.html#e2e-testing) guide. |
| 58 | + |
| 59 | +## Code of Conduct |
| 60 | + |
| 61 | +This project follows the [Linode Community Code of Conduct](https://www.linode.com/community/questions/conduct). |
| 62 | + |
| 63 | +## Vulnerability Reporting |
| 64 | + |
| 65 | +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. |
| 66 | + |
| 67 | +## Licensing |
| 68 | + |
| 69 | +See the [LICENSE file](/LICENSE) for our project's licensing. |
0 commit comments