Skip to content

Commit

Permalink
Updating CONTRIBUTING.md accordingly
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamacedo86 committed Jan 14, 2025
1 parent c088fe4 commit 905d0eb
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ As you may or may not know, the Operator-Controller project aims to deliver the
The user experience captured in the OLM V1 PRD introduces many requirements that are best satisfied by a microservices architecture. The OLM V1 experience currently relies on two projects:

- [The Operator-Controller project](https://github.com/operator-framework/operator-controller/), which is the top level component allowing users to specify operators they'd like to install.
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
- [The Catalogd project](https://github.com/operator-framework/operator-controller/tree/main/catalogd), which hosts operator content and helps users discover installable content.

Each of the projects listed above have their own governance, release milestones, and release cadence. However, from a technical perspective, the "OLM V1 experience" matches the experienced offered by the operator-controller project, the top level component which depends on Catalogd.

Expand Down Expand Up @@ -59,6 +59,8 @@ you can follow the steps below to test your changes:
make kind-load kind-deploy
```

**Note** You can use `make run` instead of the above steps.

## How to debug controller tests using ENVTEST

[ENVTEST](https://book.kubebuilder.io/reference/envtest) requires k8s binaries to be downloaded to run the tests.
Expand Down Expand Up @@ -120,7 +122,6 @@ As discussed earlier, the operator-controller adheres to a microservice architec
Unsure where to submit an issue?
- [The Operator-Controller project](https://github.com/operator-framework/operator-controller/), which is the top level component allowing users to specify operators they'd like to install.
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.

Don't worry if you accidentally submit an issue against the wrong project, if we notice that an issue would fit better with a separate project we'll move it to the correct repository and mention it in the #olm-dev slack channel.

Expand Down

0 comments on commit 905d0eb

Please sign in to comment.