Skip to content

Update CONTRIBUTING.md with DCO and CI info#162

Merged
openshift-merge-bot[bot] merged 1 commit into
mainfrom
amandahla-patch-1
Jun 15, 2026
Merged

Update CONTRIBUTING.md with DCO and CI info#162
openshift-merge-bot[bot] merged 1 commit into
mainfrom
amandahla-patch-1

Conversation

@amandahla

@amandahla amandahla commented Jun 11, 2026

Copy link
Copy Markdown
Member

Added DCO sign-off requirement and CI validation details.

PR Summary

Detailed Description of the Issue

Related Issues and PRs

  • Jira: OCM-XXXXX
  • Fixes: #
  • Related PR(s):
  • Related design/docs:

Type of Change

  • feat - adds a new module capability or new user-facing behavior.
  • fix - resolves incorrect module behavior or bug.
  • docs - updates documentation only.
  • style - formatting/naming changes with no logic impact.
  • refactor - module code restructuring with no behavior change.
  • test - adds or updates tests only.
  • chore - maintenance work (tooling, housekeeping, non-product code).
  • build - changes build system, packaging, or dependencies for build output.
  • ci - changes CI pipelines, jobs, or automation workflows.
  • perf - improves performance without changing intended behavior.

Previous Behavior

Behavior After This Change

How to Test (Step-by-Step)

Preconditions

Test Steps

Expected Results

Proof of the Fix

  • Screenshots:
  • Videos:
  • Logs/CLI output:
  • Other artifacts:

Breaking Changes

  • No breaking changes
  • Yes, this PR introduces a breaking change (describe impact and migration plan below)

Breaking Change Details / Migration Plan

Developer Verification Checklist

  • AWS-only changes: If this PR is mainly AWS-only (no rhcs resources/variables), I linked official Red Hat or cited ROSA HCP documentation that supports reference alignment, or I explained why the change still belongs in-repo per Module scope (AWS-only vs core HCP) in .cursor/rules/rosa-hcp-terraform.mdc.
  • I checked if this affects terraform-rhcs-rosa-classic and submitted (or already submitted) a companion PR when needed.
  • Commit subject/title follows [JIRA-TICKET] | [TYPE]: <MESSAGE>.
  • PR description clearly explains both what changed and why.
  • Relevant Jira/GitHub issues and related PRs are linked.
  • Tests were added/updated where appropriate.
  • I manually tested the change.
  • make pre-push-checks passes (or each step: verify, verify-gen, lint, unit-tests, license-check, docs-lint).
  • Documentation was added/updated where appropriate (see make terraform-docs).
  • Any risk, limitation, or follow-up work is documented.

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines to require Developer Certificate of Origin (DCO) sign-off on all commits. Guidance now explains how to include the required signed-off line in commit messages and reminds contributors to sign each commit before submitting changes.

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: ec665a4a-21d4-44dd-b77a-b84b1254a3bc

📥 Commits

Reviewing files that changed from the base of the PR and between 844d856 and a1dfc8c.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md

Walkthrough

The pull request adds an [!IMPORTANT] note to CONTRIBUTING.md requiring a Developer Certificate of Origin (DCO) sign-off on every commit, with guidance to use git commit -s and include the "Signed-off-by: Name " line.

Changes

DCO Governance Documentation

Layer / File(s) Summary
DCO sign-off requirement documentation
CONTRIBUTING.md
Added an [!IMPORTANT] note establishing that every commit must include a DCO sign-off line, with guidance to use git commit -s and the required "Signed-off-by: Name " format.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

lgtm

Suggested reviewers

  • jerichokeyne
🚥 Pre-merge checks | ✅ 5 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description only contains a brief statement and the template structure with most sections incomplete or filled with placeholder comments; required information like PR summary, detailed issue description, and type of change are not properly filled out. Complete the PR description by filling out the PR Summary, Detailed Description, Type of Change selection, and explaining what changed and why, as per the repository template requirements.
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating CONTRIBUTING.md with DCO sign-off requirements and CI validation information.
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.
Pr Checklist Claims Vs Evidence (Generic) ✅ Passed PR description contains markdown checklist items, but none are marked checked ([x]); only - [ ] lines, so there are no checked claims to verify against evidence.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch amandahla-patch-1

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 63-65: The commit message must be amended to match the repository
policy pattern and include a DCO sign-off: update the current commit (the one
that changed CONTRIBUTING.md) with a message following "[JIRA-TICKET] | [TYPE]:
<message>" (e.g., "OCM-00000 | docs: add DCO sign-off requirement") and include
the Signed-off-by line (use git commit --amend -s or add "Signed-off-by: Name
<email>" manually); this will satisfy the hack/commit-msg-verify.sh hook that
currently rejects "Update CONTRIBUTING.md with DCO and CI info".
🪄 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: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 782ef602-38c4-4008-88cc-da0147d91ba3

📥 Commits

Reviewing files that changed from the base of the PR and between ebde8af and 844d856.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md
Comment on lines +63 to +65
[!IMPORTANT]
DCO Sign-off Required: Every commit must include a Developer Certificate of Origin (DCO) sign-off line (Signed-off-by: Name <email>). Use git commit -s when committing.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Commit message format violation blocks merge.

The PR's commit message "Update CONTRIBUTING.md with DCO and CI info" does not follow the required format documented in this file. The commit must be amended to match [JIRA-TICKET] | [TYPE]: <message> (e.g., "OCM-00000 | docs: add DCO sign-off requirement" or a valid JIRA ticket if assigned). Additionally, once amended, it must include the DCO sign-off line (-s flag or manual Signed-off-by: line).

Pipeline validation (hack/commit-msg-verify.sh) will reject this commit until the format is corrected.

How to fix:

git commit --amend --no-edit
# Then update the commit message interactively to follow the format, or:
git commit --amend -m "OCM-00000 | docs: add DCO sign-off requirement" -s
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CONTRIBUTING.md` around lines 63 - 65, The commit message must be amended to
match the repository policy pattern and include a DCO sign-off: update the
current commit (the one that changed CONTRIBUTING.md) with a message following
"[JIRA-TICKET] | [TYPE]: <message>" (e.g., "OCM-00000 | docs: add DCO sign-off
requirement") and include the Signed-off-by line (use git commit --amend -s or
add "Signed-off-by: Name <email>" manually); this will satisfy the
hack/commit-msg-verify.sh hook that currently rejects "Update CONTRIBUTING.md
with DCO and CI info".

Source: Pipeline failures

Signed-off-by: Amanda H. L. de Andrade Katz <amanda.katz@redhat.com>
@amandahla amandahla force-pushed the amandahla-patch-1 branch from 844d856 to a1dfc8c Compare June 11, 2026 19:11
@amandahla

Copy link
Copy Markdown
Member Author

/override ci/prow/rosa-hcp-private
/override ci/prow/rosa-hcp-public

@openshift-ci

openshift-ci Bot commented Jun 12, 2026

Copy link
Copy Markdown

@amandahla: Overrode contexts on behalf of amandahla: ci/prow/rosa-hcp-private, ci/prow/rosa-hcp-public

Details

In response to this:

/override ci/prow/rosa-hcp-private
/override ci/prow/rosa-hcp-public

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@amandahla amandahla added the documentation Improvements or additions to documentation label Jun 12, 2026
@olucasfreitas

Copy link
Copy Markdown
Contributor

/lgtm
/approve

@openshift-ci

openshift-ci Bot commented Jun 12, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amandahla, olucasfreitas

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:
  • OWNERS [amandahla,olucasfreitas]

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

@amandahla

Copy link
Copy Markdown
Member Author

/override ci/prow/rosa-hcp-private
/override ci/prow/rosa-hcp-public

@openshift-ci

openshift-ci Bot commented Jun 15, 2026

Copy link
Copy Markdown

@amandahla: Overrode contexts on behalf of amandahla: ci/prow/rosa-hcp-private, ci/prow/rosa-hcp-public

Details

In response to this:

/override ci/prow/rosa-hcp-private
/override ci/prow/rosa-hcp-public

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-merge-bot openshift-merge-bot Bot merged commit 80f992d into main Jun 15, 2026
11 checks passed
@openshift-ci

openshift-ci Bot commented Jun 15, 2026

Copy link
Copy Markdown

@amandahla: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/rosa-hcp-public a1dfc8c link unknown /test rosa-hcp-public
ci/prow/rosa-hcp-private a1dfc8c link unknown /test rosa-hcp-private

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

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

Labels

approved dco-signoff: yes documentation Improvements or additions to documentation lgtm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants