Contribute

Welcome to the collaboration guide for the Biznet GIO infrastructure as code project. Everything in this project is open source, and this section teaches you exactly how to help: what lives where, how the pieces work, which conventions to follow, how to open issues and pull requests, and how the pipelines keep every change safe.

​

The project map

Five repositories make up this project. They form a chain: two providers that talk to the Biznet GIO API, two example repos that show every feature of those providers working, and one docs site that teaches both. This Contribute section covers the three repos you can change without deep provider knowledge: the docs site and the two example repos. The two provider repos are Go codebases with their own development flow; if you find a provider bug, report it as an issue on the provider repo and it usually gets fixed there first.

​

How the repos communicate

The three repos reference each other constantly, and that wiring is part of the design:

• The example repos link to the docs site tutorials that explain the patterns they use, like the Capstone tutorial.
• The docs site links to the example repos on its examples page, in the sidebar GitHub menu, and from the reference pages.
• The docs site reference pages show code that must match what the providers and examples actually do. When the examples catch a mismatch, both the examples and the docs get fixed together.

That last point matters a lot. This repo already caught real bugs in the docs by compiling every example against the real SDKs, for example the GPU keypair id quirk. Your contributions should keep that loop going: code first, docs second, both consistent.

​

Reading order

Follow this order if you are new here:

1. How the repos are organized to know where everything lives.
2. Local setup to get the tools and tokens you need.
3. Conventions to learn the house rules before you write anything.
4. Commits and pull requests to learn the contribution workflow.
5. Issues and CODEOWNERS and reviews to learn how communication and review work.
6. Pipelines to understand the safety net every change runs through.
7. The repo deep dives, Terraform and Pulumi, to understand the code itself, and the complete code walkthrough for the exhaustive file-by-file reference.
8. Step-by-step walkthroughs when you are ready to make your first change.

​

Standards this project follows

Every convention this project uses is a published standard. The pages above link to the canonical source for each one, but here are the big three up front: Every repo also has a CONTRIBUTING.md at its root that summarizes its own rules and links back here:

• Terraform examples CONTRIBUTING.md
• Pulumi examples CONTRIBUTING.md