Contribute

Contributions can change the documentation, the Go service, the charm, the rock, or several of these areas. Choose the path that matches your change, and follow both when code and documentation change together. On either path, CI workflows describes what CI runs on each change.

Documentation contributions

For prose, navigation, examples, tutorials, and how-to guides:

• Improve the documentation: install the documentation tools, preview a change, and run the documentation checks and tests.

Prose-only changes need no local Juju environment. If a documentation command builds, deploys, or changes the running service, also follow the code path, starting with Set up a development environment, to validate it.

Code contributions

For the Go service, charm code, rock or charm recipes, and integration tests:

• Set up a development environment: prepare a VM with the tools that build, test, and deploy gopkg-k8s from source. Start here.

• Improve the code: run the tests, then build and deploy your change.

• Run the integration suite locally: run the Juju integration suite by hand.

• Troubleshoot the development environment: fix the failures that come up while building from source.