chore(docs): sync contributing guides by frewilhelm · Pull Request #2285 · open-component-model/open-component-model

frewilhelm · 2026-04-14T13:26:10Z

Note

The reported failure of Verify links can be ignored as the missing side will be added with this PR

Summary

Overhauls the contributing documentation across the mono-repo. Introduces a layered guide system: a central website guide for the general contribution process, a root umbrella guide for repo-wide tooling, and area-specific guides for each major component.

What changed

Central contributing guide (website/content/community/contributing.md) — new. Fork-and-pull workflow, commit conventions, issue guidance, reviewer expectations, security reporting, AI-generated code policy.
Root contributing guide (CONTRIBUTING.md) — rewritten from Go-specific to language-agnostic umbrella. Project structure, prerequisites, common tasks, links to area guides.
Go bindings guide (bindings/go/CONTRIBUTING.md) — new. Module overview (links to README), Go workspace with cross-module workflow, breaking API change process, testing conventions (links to docs/coding-patterns.md), module release workflow.
CLI guide (cli/CONTRIBUTING.md) — new. Architecture (command/context/binding layers), bootstrap sequence, plugin system, how to add a command, coding patterns, building, testing.
Controller guide (kubernetes/controller/CONTRIBUTING.md) — new. Reconciliation pipeline (Repository/Component/Resource/Deployer), OCM integration (plugin manager, resolution worker pool), CRD generation pipeline, Helm chart workflow, testing (envtest + Kind E2E).
Website guide (website/CONTRIBUTING.md) — extended. Local dev setup, linting, fixed content type descriptions and repository placement table.

Which issue(s) this PR fixes

Related to open-component-model/ocm-project#981

Test plan

All external links verified live
All local file/directory references verified to exist
Task commands verified against actual Taskfiles
Website builds with npm run build
Markdown linting passes

netlify · 2026-04-14T13:26:17Z

✅ Deploy Preview for ocm-website ready!

Name	Link
🔨 Latest commit	`6fb9598`
🔍 Latest deploy log	https://app.netlify.com/projects/ocm-website/deploys/69f1ea2060234d0008c98140
😎 Deploy Preview	https://deploy-preview-2285--ocm-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2026-04-14T13:26:20Z

📝 Walkthrough

Walkthrough

Adds and reorganizes contributor documentation across the mono-repo: new and retargeted CONTRIBUTING.md files for root, website, Go bindings, CLI, and Kubernetes controller; adds a website community contributing page, updates page front-matter and appends six entries to .github wordlist. (34 words)

Changes

Cohort / File(s)	Summary
Root & wordlist `CONTRIBUTING.md`, `.github/config/wordlist.txt`	Root CONTRIBUTING.md rewritten as mono-repo entrypoint (Taskfile, tooling, lint/generate guidance, updated Go prerequisite); `.github/config/wordlist.txt` appended six entries: `Doks`, `envtest`, `ocmtypegen`, `reconcilers`, `Thulite`, `yq`.
Go bindings guide `bindings/go/CONTRIBUTING.md`	New guide for Go bindings modules: module layout, optional `go.work`, module-scoped dev/test flow, breaking-change/release workflow, generator & test conventions, and module onboarding steps.
CLI guide `cli/CONTRIBUTING.md`	New CLI contributor doc describing Cobra command layout, `PersistentPreRunE` bootstrap sequence, plugin registry usage, doc generation, build/test tasks, and Docker-based CLI integration test workflow.
Kubernetes controller guide `kubernetes/controller/CONTRIBUTING.md`	New controller guide covering reconciler pipeline, worker/cache behavior, CRD/RBAC generation with kubebuilder markers, Helm packaging, envtest/Kind E2E patterns, Taskfile validation, and required tooling.
Website & community pages `website/CONTRIBUTING.md`, `website/content/community/contributing.md`, `website/content/community/community.md`	Retargeted website contributing guide (Hugo/Node, Diataxis templates, content classification); added community contributing page with fork/PR process, DCO/commit-signing, AI-generated-code compliance, help/security links; added `weight: 1` front-matter to community page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

feat: unify workflows, remove duplications and update packages for the website #2231 — Overlaps edits to .github/config/wordlist.txt and wordlist entries.
chore: port over add governance page and person card component #2269 — Modifies website community content and may overlap with the new community contributing page.
chore: add an agents.md file that describes llm behavior #1788 — Related to repository metadata/wordlist and contribution guidance intersections.

Suggested reviewers

morri-son
piotrjanik

Poem

🐰 I hopped through docs both near and far,

I stitched new guides beneath the star.
From CLI flags to Helm chart streams,
I planted pages for contributors' dreams.
Tap the leaves — the repo shares new schemes!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'chore(docs): sync contributing guides' directly and concisely summarizes the primary change: a comprehensive overhaul of contributing documentation across the mono-repo with a new layered guide system.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description check	✅ Passed	The pull request description clearly documents a comprehensive overhaul of contributing documentation, detailing new and rewritten guides for each major component area with specific file locations and content coverage.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

frewilhelm · 2026-04-15T09:11:51Z

@coderabbitai review

coderabbitai · 2026-04-15T09:15:16Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@website/content/community/contributing.md`:
- Line 137: Update the intro sentence text that currently reads "there a certain
requirements that need to be reflected and adhered to when making
contributions." by correcting the grammar to "there are certain requirements
that need to be reflected and adhered to when making contributions." Replace the
incorrect phrase in the same paragraph string so the rest of the sentence
remains unchanged.
- Around line 79-87: The "Sign-off and signed commits" callout currently states
DCO sign-off, cryptographic signing and DCO CI verification as universal
requirements; change the wording to indicate these are repository- or
org-specific requirements (e.g., "If your repo/org requires signing: ...") and
soften absolute phrases to "may be required" or "for example, some repos
require"; update the git example block to show git commit -s and add a commented
alternative for cryptographic signing (e.g., add a commented line showing git
commit -S -s ...), replace the CI sentence ("Once you open a pull request, CI
checks run automatically (linting, tests, CodeQL analysis, DCO verification).")
with a generic phrasing like "CI checks run automatically (for example: linting,
tests, CodeQL analysis, and other repo-specific checks)", and apply the same
wording adjustments to the other occurrences that mention DCO verification and
signing elsewhere in the document (the paragraphs that reference DCO
verification and signing).

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 41598dbe-de94-4f3e-be64-3b236f73d66c

📥 Commits

Reviewing files that changed from the base of the PR and between a542b39 and 9032b24.

📒 Files selected for processing (1)

website/content/community/contributing.md

frewilhelm · 2026-04-17T10:48:04Z

IMO it makes sense to create new CONTRIBUTING.md for bindings/go and cli because new language bindings will need their own CONTRIBUTING.md too (e.g. go vs. python).

frewilhelm · 2026-04-17T13:01:28Z

The reported failure of Verify links can be ignored as the missing side will be added with this PR

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

Skarlso

Just three remarks, looks a lot better!

…omponent-model into sync-contributing

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

matthiasbruns

lgtm

> [!NOTE] > The reported failure of [`Verify links`](https://github.com/open-component-model/open-component-model/actions/runs/24566335739/job/71827381244?pr=2285) can be ignored as the missing side will be added with this PR  ## Summary Overhauls the contributing documentation across the mono-repo. Introduces a layered guide system: a central website guide for the general contribution process, a root umbrella guide for repo-wide tooling, and area-specific guides for each major component. ### What changed - **Central contributing guide** (`website/content/community/contributing.md`) — new. Fork-and-pull workflow, commit conventions, issue guidance, reviewer expectations, security reporting, AI-generated code policy. - **Root contributing guide** (`CONTRIBUTING.md`) — rewritten from Go-specific to language-agnostic umbrella. Project structure, prerequisites, common tasks, links to area guides. - **Go bindings guide** (`bindings/go/CONTRIBUTING.md`) — new. Module overview (links to README), Go workspace with cross-module workflow, breaking API change process, testing conventions (links to `docs/coding-patterns.md`), module release workflow. - **CLI guide** (`cli/CONTRIBUTING.md`) — new. Architecture (command/context/binding layers), bootstrap sequence, plugin system, how to add a command, coding patterns, building, testing. - **Controller guide** (`kubernetes/controller/CONTRIBUTING.md`) — new. Reconciliation pipeline (Repository/Component/Resource/Deployer), OCM integration (plugin manager, resolution worker pool), CRD generation pipeline, Helm chart workflow, testing (envtest + Kind E2E). - **Website guide** (`website/CONTRIBUTING.md`) — extended. Local dev setup, linting, fixed content type descriptions and repository placement table. ## Which issue(s) this PR fixes Related to open-component-model/ocm-project#981 ## Test plan - [x] All external links verified live - [x] All local file/directory references verified to exist - [x] Task commands verified against actual Taskfiles - [x] Website builds with `npm run build` - [x] Markdown linting passes --------- Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com> Co-authored-by: Matthias Bruns <github@matthiasbruns.com> 0a4b4c3

github-actions Bot added kind/chore chore, maintenance, etc. size/m Medium labels Apr 14, 2026

frewilhelm commented Apr 14, 2026

View reviewed changes

Comment thread website/content/community/contributing.md Outdated

piotrjanik reviewed Apr 14, 2026

View reviewed changes

Comment thread website/content/community/contributing.md

piotrjanik reviewed Apr 14, 2026

View reviewed changes

Comment thread website/content/community/contributing.md

frewilhelm mentioned this pull request Apr 15, 2026

docs: add formal test policy for new features and bug fixes #2289

Merged

3 tasks

coderabbitai Bot reviewed Apr 15, 2026

View reviewed changes

Comment thread website/content/community/contributing.md

Comment thread website/content/community/contributing.md Outdated

github-actions Bot added size/l Large component/github-actions Changes on GitHub Actions or within `.github/` directory and removed size/m Medium labels Apr 17, 2026

frewilhelm force-pushed the sync-contributing branch from c31dff2 to ecc1db9 Compare April 17, 2026 15:26

github-actions Bot added the area/documentation Documentation related label Apr 17, 2026

frewilhelm added 12 commits April 17, 2026 17:28

start with central contributing guide on the website

8545760

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

update the general contributing guide

727a9e3

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

fix linter issues

5a7fc0a

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

restructure sections

fa0552a

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

fix icons

a76440a

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

update icons again

2a0ac72

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

fix typo

8dbd4cd

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

clarify guideline

1c01869

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

add security, reviewer, license, and issue section

568ae2f

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

refer to correct repository

7bd1e8d

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

make security advisor general

f283d4d

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

order documents

c93c47b

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

matthiasbruns reviewed Apr 28, 2026

View reviewed changes

Comment thread bindings/go/CONTRIBUTING.md

matthiasbruns reviewed Apr 28, 2026

View reviewed changes

Comment thread cli/CONTRIBUTING.md Outdated

matthiasbruns reviewed Apr 28, 2026

View reviewed changes

Comment thread cli/CONTRIBUTING.md Outdated

Skarlso reviewed Apr 28, 2026

View reviewed changes

Comment thread bindings/go/CONTRIBUTING.md Outdated

Comment thread bindings/go/CONTRIBUTING.md Outdated

Comment thread bindings/go/CONTRIBUTING.md Outdated

Skarlso reviewed Apr 28, 2026

View reviewed changes

Comment thread bindings/go/CONTRIBUTING.md Outdated

frewilhelm added 6 commits April 28, 2026 12:51

Merge branch 'main' of https://github.com/open-component-model/open-c…

8952276

…omponent-model into sync-contributing

clarify breaking change procedure

ff032be

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

slim down instruction on how to create a new command

1de916c

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

clarify depnedency injection

e94d2b0

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

misc...

b7418e6

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

rewrite and restructure go work section

ca7ff49

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

piotrjanik reviewed Apr 28, 2026

View reviewed changes

Comment thread website/CONTRIBUTING.md Outdated

frewilhelm added 3 commits April 28, 2026 15:19

update feature-based decision tree

f6fbecc

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>

Merge branch 'main' into sync-contributing

833ca0b

Merge branch 'main' into sync-contributing

db01da5

frewilhelm requested review from Skarlso, matthiasbruns and piotrjanik April 29, 2026 06:55

matthiasbruns approved these changes Apr 29, 2026

View reviewed changes

frewilhelm and others added 2 commits April 29, 2026 09:36

Merge branch 'main' into sync-contributing

f7f4030

Merge branch 'main' into sync-contributing

adf86d1

Skarlso approved these changes Apr 29, 2026

View reviewed changes

Merge branch 'main' into sync-contributing

6fb9598

frewilhelm merged commit 0a4b4c3 into open-component-model:main Apr 29, 2026
40 of 41 checks passed

coderabbitai Bot mentioned this pull request May 6, 2026

chore(docs): add onboarding and how we work guide #2444

Merged

frewilhelm deleted the sync-contributing branch May 11, 2026 12:46

coderabbitai Bot mentioned this pull request May 12, 2026

feat: how to interact with the SIG Runtime #2428

Merged

5 tasks

coderabbitai Bot mentioned this pull request Jun 2, 2026

chore(fix): update coc to linux foundation eu #2727

Merged

Conversation

frewilhelm commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What changed

Which issue(s) this PR fixes

Test plan

Uh oh!

netlify Bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for ocm-website ready!

Uh oh!

coderabbitai Bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

Uh oh!

Uh oh!

Uh oh!

frewilhelm commented Apr 15, 2026

Uh oh!

coderabbitai Bot commented Apr 15, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

frewilhelm commented Apr 17, 2026

Uh oh!

frewilhelm commented Apr 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Skarlso left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matthiasbruns left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

frewilhelm commented Apr 14, 2026 •

edited

Loading

netlify Bot commented Apr 14, 2026 •

edited

Loading

coderabbitai Bot commented Apr 14, 2026 •

edited

Loading