Skip to content

docs: add contribution and DCO guidance - #2232

Open
abays wants to merge 1 commit into
openstack-k8s-operators:mainfrom
abays:dco-coreos-contribution-policy
Open

abays wants to merge 1 commit into
openstack-k8s-operators:mainfrom
abays:dco-coreos-contribution-policy

Conversation

@abays

@abays abays commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

Add the canonical DCO 1.1 and document the CoreOS contribution method. Clarify that Signed-off-by is not required on every commit, and link the guide from README.

Add the canonical DCO 1.1 and document the CoreOS contribution method.
Clarify that Signed-off-by is not required on every commit, and link
the guide from README.
@openshift-ci
openshift-ci Bot requested review from rabi and slagle November 17, 2026 14:23
@github-actions

Copy link
Copy Markdown

OpenStackControlPlane CRD Size Report

Metric Value
CRD JSON size 347186 bytes (339KB)
Base branch size 347186 bytes
Change +0.00%
Status yellow — growing
Threshold reference
Color Range Meaning
🟢 green < 300KB Comfortable
🟡 yellow 300–400KB Growing
🟠 orange 400–750KB Concerning
🔴 red > 750KB Approaching 1.5MB etcd limit (cut in half to allow space for update)

@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Added contributor guidelines covering the Developer Certificate of Origin and the project’s sign-off process.
    • Updated the README to link to the contribution guidelines.

The change adds a DCO Version 1.1 document, describes DCO requirements and the CoreOS method in CONTRIBUTING.md, and links to the contribution guidance from the README.

Changes: Contribution Guidance

Layer / File(s) Summary
DCO terms and contribution guidance
DCO, CONTRIBUTING.md, README.md
DCO contains the Version 1.1 terms. CONTRIBUTING.md describes the DCO and states that per-commit Signed-off-by trailers are not required under the CoreOS method. The README links to CONTRIBUTING.md.

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Other

Merge Risk: Minimal · up to 951c4

This PR adds contribution and DCO documentation and links it from the README. It does not change runtime behavior and is low risk to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "docs: add contribution and DCO guidance" matches the main change. The PR adds the DCO 1.1 file, adds contribution guidance to CONTRIBUTING.md, and links that guide from the README.
Description check Passed The description states that the PR adds DCO 1.1, documents the CoreOS contribution method, clarifies that Signed-off-by is not required on every commit, and links the guide from README. This matches t…
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.
Full details: Description check

Explanation

The description states that the PR adds DCO 1.1, documents the CoreOS contribution method, clarifies that Signed-off-by is not required on every commit, and links the guide from README. This matches the changeset.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Central YAML (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 6905c679-2ca2-49f7-ac1f-e8a1e453cf11
Commits

Reviewing files that changed from the base of the PR and between be32086 and 951c412.

Files selected for processing: 3

  • CONTRIBUTING.md
  • DCO
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

@abays
abays requested review from dprince, gibizer and stuggi November 17, 2026 16:44
@openshift-ci

openshift-ci Bot commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abays, gibizer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants