Add getting started and contributing guide#81
Open
alicefr wants to merge 2 commits into
Open
Conversation
Cover building, running unit and e2e tests, bink internal registry usage, and code style checks. Assisted-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Alice Frosi <afrosi@redhat.com>
Cover prerequisites, development environment, code style, DCO sign-off, commit conventions, and PR process. Assisted-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Alice Frosi <afrosi@redhat.com>
ptalgulk01
suggested changes
Jun 30, 2026
| @@ -0,0 +1,160 @@ | |||
| # Getting Started | |||
|
|
|||
| This guide covers how to build, test, and develop the Bootc Operator. | |||
There was a problem hiding this comment.
Just a thought, as this could be first file for any new comer to open, should we also mention about bootc-operator and to know more about it then re-direct it to that .md file for easy access?
Comment on lines
+38
to
+51
| ## Running Unit Tests | ||
|
|
||
| Unit tests use the controller-runtime | ||
| [envtest](https://book.kubebuilder.io/reference/envtest) framework, which | ||
| provides a local control plane (etcd + API server) without a full cluster. The | ||
| required binaries are downloaded automatically. | ||
|
|
||
| ```shell | ||
| make unit # Run all unit tests | ||
| make unit V=1 # Verbose output | ||
| make unit RUN=Foo # Run tests matching "Foo" | ||
| ``` | ||
|
|
||
| ## Running End-to-End Tests |
There was a problem hiding this comment.
For unit and e2e test should we mention the test files directory?
Comment on lines
+21
to
+26
| ## Building | ||
|
|
||
| ```shell | ||
| make build # Build all binaries (manager + daemon) to ./bin/ | ||
| make buildimg # Build the container image (default: bootc-operator:dev) | ||
| ``` |
There was a problem hiding this comment.
Would it be beneficial to include the systemctl --user start podman.socket command as a step in this process?
Collaborator
|
Hmm, do we need both a GETTING_STARTED and a CONTRIBUTING? |
jlebon
reviewed
Jun 30, 2026
|
|
||
| This collects the same diagnostics into `_output/logs/gather-bink/`. | ||
|
|
||
| To tear down the cluster when done: |
Collaborator
There was a problem hiding this comment.
Feels weird to have this live in the test logs section. Perhaps in the previous one instead?
Comment on lines
+85
to
+90
| Options: | ||
| ```shell | ||
| make e2e V=1 # Verbose streaming output | ||
| make e2e RUN=Foo # Run tests matching "Foo" | ||
| ``` |
Collaborator
There was a problem hiding this comment.
I would just merge this in the code block above that introduces make e2e, like you did for make unit.
Comment on lines
+125
to
+148
| ## Investigating CI Failures | ||
|
|
||
| CI runs on [GitHub Actions](https://github.com/bootc-dev/bootc-operator/actions) | ||
| and consists of three jobs: `unit`, `build-bink`, and `e2e`. When a run fails, | ||
| you can inspect it using the `gh` CLI. | ||
|
|
||
| View a run summary: | ||
|
|
||
| ```shell | ||
| gh run view <run-id> --repo bootc-dev/bootc-operator | ||
| ``` | ||
|
|
||
| ### Downloading E2E Logs | ||
|
|
||
| The e2e job uploads diagnostic logs as a GitHub Actions artifact named | ||
| `e2e-logs`. These contain the same logs collected by `make gather-bink` | ||
| (operator pod logs, node journals, event dumps, etc.). Download them with: | ||
|
|
||
| ```shell | ||
| gh run download <run-id> --repo bootc-dev/bootc-operator | ||
| ``` | ||
|
|
||
| This creates a local `e2e-logs/` directory with per-test subdirectories | ||
| matching the structure described in [Finding Test Logs](#finding-test-logs). |
Collaborator
There was a problem hiding this comment.
Hmm, unsure whether this belongs here. This seems like more general advice.
Not against it though!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add the started and contributing guide for newcomers.
The get starting guide is still missing a good example. I think it will be easier to add one once we merge #75. So we can reference by tag and it gets a bit easier to reference the images
Fixes: #54