Add getting started and contributing guide#81
Conversation
|
Hmm, do we need both a GETTING_STARTED and a CONTRIBUTING? |
| ## 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). |
There was a problem hiding this comment.
Hmm, unsure whether this belongs here. This seems like more general advice.
Not against it though!
There was a problem hiding this comment.
I would like to keep it. I always find it helpful to know how and where to find the logs, especially for people that open pull requests for the first time.
alicefr
force-pushed
the
contributing
branch
2 times, most recently
from
48b01f3 to
f1082ab
Compare
|
I merged the 2 document and addressed the comments. Additionally, I also included an |
jlebon
left a comment
jlebon
left a comment
There was a problem hiding this comment.
Some nits but LGTM as is!
jlebon
left a comment
jlebon
left a comment
There was a problem hiding this comment.
LGTM! Will let @HarshwardhanPatil07 or @ptalgulk01 do a final pass.
| Before diving into the code, familiarize yourself with the project from a user | ||
| perspective by reading the [README](README.md) and the | ||
| [Architecture](docs/ARCHITECTURE.md) document. We also recommend getting | ||
| familiar with [bink](https://github.com/bootc-dev/bink), which is used to | ||
| create lightweight Kubernetes clusters backed by bootc nodes for development | ||
| and testing. |
There was a problem hiding this comment.
It seems more of a prerequisite section
There was a problem hiding this comment.
let me add it a subsection
| ### Code Review | ||
|
|
||
| All submissions require review before merging. Reviewers look for: | ||
|
|
||
| - Correctness and test coverage | ||
| - Consistency with existing patterns | ||
| - Clear commit messages | ||
| - Generated files kept in sync |
There was a problem hiding this comment.
not sure about this but I was taking a look at bootc, are we planning to have REVIEW.md? If Yes, then probably we can include it there.
This includes how to setup a development environment using bink, the building and testing setup, how to interact and debug CI failure and how to submit PRs. Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
4 participants
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