👍🎉 First off, thank you for taking the time to contribute to Liqo! 🎉👍
The following is a set of guidelines for contributing to Liqo, which are hosted in the liqotech Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Unsure where to begin contributing to Liqo? You can start by looking through the help-wanted issues.
The liqo repository structure follows the Golang standard layout. All components have the same structure:
If you want to read about using Liqo or developing packages in Liqo, the Liqo Flight Manual is free and available online.
Liqo leverages lerna-changelog to create the changelog of a certain version. PRs with the following labels applied will be considered for the changelog:
Liqo components can be developed locally. We provide a deployment script to spawn multiple kubernetes clusters by using Kind with Liqo installed. This script can be used as a starting point to improve/replace one Liqo component.
The process described here has several goals:
Atom Contributing Guidelines inspired us when writing this document. Many thanks!