👍🎉 First off, we appreciate you taking the time to contribute! THANK YOU! 🎉👍
We put together the handy guide below to help you get support for your work. Read on!
The Linode Community is a great place to get additional support.
Please open a github issue to report bugs or suggest features.
When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first.
Detailed bug reports and requests are easier for us to work with. Please include the following in your issue:
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made, relevant to the bug
- Anything unusual about your environment or deployment
- Screenshots and code samples where illustrative and helpful
We follow the fork and pull model for open source contributions.
Tips for a faster merge:
- address one feature or bug per pull request.
- large formatting changes make it hard for us to focus on your work.
- follow language coding conventions.
- make sure that tests pass.
- make sure your commits are atomic, addressing one change per commit.
- add tests!
Everytime a commit is merged into master, a new patch release is automatically drafted with a changelog. You can modify (tag name, changelog, title, etc.) and publish the release via the releases page.
When a release is published, the release workflow builds and pushes the docker image to Dockerhub.
This project follows the Linode Community Code of Conduct.
If you discover a potential security issue in this project we ask that you notify Linode Security via our vulnerability reporting process. Please do not create a public github issue.
See the LICENSE file for our project's licensing.