Skip to content

docs: say that web commits are signed off now that the repository requires it - #1566

Merged
jmrplens merged 1 commit into
mainfrom
docs-web-commit-signoff
Oct 28, 2026
Merged

jmrplens merged 1 commit into
mainfrom
docs-web-commit-signoff

Conversation

@jmrplens

Copy link
Copy Markdown
Owner

I turned on Require contributors to sign off on web-based commits today, after the DCO check of #1562 merged, so GitHub now signs off a commit made in its web interface, such as an applied review suggestion, with its author's identity.

This updates the two places that still said the setting was off: the sentence in CONTRIBUTING.md that asked for a trailer typed by hand, and the Current state of the web commit sign-off item in docs/development/repository-settings.md, which now reads applied, with web_commit_signoff_required: true.

Documentation only; markdownlint and node scripts/check-doc-links.mjs pass.

…uires it

The repository requires sign-off on web-based commits since 2026-10-28,
after the DCO check merged in #1562, so CONTRIBUTING no longer asks for a
trailer typed by hand on an applied suggestion, and the repository
settings page records the setting as applied.

Signed-off-by: José M. Requena Plens <mail@jmrp.io>
@jmrplens jmrplens added this to the 3.4.0 milestone Oct 28, 2026
@sourcery-ai

sourcery-ai Bot commented Oct 28, 2026

Copy link
Copy Markdown

Sorry @jmrplens, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 5 days and 18 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 28, 2026
@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between f486238 and 681dd39.

Files selected for processing: 2
  • CONTRIBUTING.md
  • docs/development/repository-settings.md

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

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Clarified that GitHub web-interface commits are signed off automatically and don’t need a manually entered sign-off trailer.
    • Updated the repository settings documentation to reflect that web commit sign-off is enabled.

The documentation now records that GitHub web-interface commits require sign-off. The contribution guidance says contributors do not need to type a sign-off trailer for those commits.

Changes: Web commit sign-off

Layer / File(s) Summary
Record the setting and update guidance
docs/development/repository-settings.md, CONTRIBUTING.md
The settings documentation records web_commit_signoff_required: true as applied on 2026-10-28. The contribution guidance says GitHub signs off web-interface commits, so no manually typed trailer is needed.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related issues

  • jmrplens/gitlab-mcp-server#1545 — The issue adopts the Developer Certificate of Origin and requires Signed-off-by trailers. This change documents the web commit sign-off setting and covers part of that objective.
Merge Risk: Minimal · up to 681dd

This documentation-only change is ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title is a short, specific docs change. It names the main change: web-based commits are now signed off because the repository requires it. The title matches the summary and the objectives. Its len…
Description check Passed The description states the change clearly: the web commit sign-off setting was turned on after #1562 merged, and the two docs that said it was off are updated. It names the files changed and the verif…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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: Title check

Explanation

The title is a short, specific docs change. It names the main change: web-based commits are now signed off because the repository requires it. The title matches the summary and the objectives. Its length and wording are acceptable, though a few words could be trimmed.

Full details: Description check

Explanation

The description states the change clearly: the web commit sign-off setting was turned on after #1562 merged, and the two docs that said it was off are updated. It names the files changed and the verification run (markdownlint and check-doc-links). It does not fill in the template's Related Issue, Type of Change, Changes Made, How to Test, or Checklist sections. The Breaking Changes section is also absent, though it would read N/A. The description is mostly complete for a documentation-only change, but the missing template sections should be added.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@sonarqubecloud

Copy link
Copy Markdown

@jmrplens
jmrplens merged commit 6c9066a into main Oct 28, 2026
38 checks passed
@jmrplens
jmrplens deleted the docs-web-commit-signoff branch October 28, 2026 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v3.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant