Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 1.79 KB

How to contribute to cloud-init

Thank you for wanting to help us improve cloud-init! There are a variety of ways you can contribute to this project, including no-code and low-code options. This documentation will help orient you with our processes.

Please make sure that you read this guide before starting to contribute. It contains all the details you need to know to give your contribution the best chance of being accepted.

Cloud-init is hosted and managed on GitHub. If you're not familiar with how GitHub works, their quickstart documentation provides an excellent introduction to all the tools and processes you'll need to know.

Prerequisites

Before you can begin, you will need to:

  • Read and agree to abide by our Code of Conduct.

  • Sign the Canonical contributor license agreement. This grants us your permission to use your contributions in the project.

  • Create (or have) a GitHub account. We will refer to your GitHub username as GH_USER.

Getting help

We use IRC and have a dedicated #cloud-init channel where you can contact us for help and guidance. This link will take you directly to our IRC channel on Libera. Please don't be afraid to reach out if you need help constructing your pull request.

Instructions for contributors

The best way to get started is by checking out the "Development" section in our documentation. This covers everything; from how to find issues to work on, to how cloud-init is structured and useful resources, through to making your first PR and getting it accepted.