Skip to content

docs(agents): add rules for DCO sign-off, .test TLD, backtick formatting, and Sphinx version directives#1144

Merged
LalatenduMohanty merged 1 commit into
python-wheel-build:mainfrom
tiran:docs/agents-dco-test-tld-backticks
May 12, 2026
Merged

docs(agents): add rules for DCO sign-off, .test TLD, backtick formatting, and Sphinx version directives#1144
LalatenduMohanty merged 1 commit into
python-wheel-build:mainfrom
tiran:docs/agents-dco-test-tld-backticks

Conversation

@tiran

@tiran tiran commented May 12, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What

  • enforce git commit --signoff for DCO sign-off (agent was sometimes ignoring the rule)
  • use .test TLD instead of example.com in tests and examples
  • use single backticks in markdown/commit messages, double backticks in .rst
  • use Sphinx versionadded/versionremoved/versionchanged directives for user-facing changes

Why

Agent was sometimes ignoring the --signoff rule. I have to remind the agent of .test TLD, backtickets and Sphinx directives regularly.

@tiran tiran requested a review from a team as a code owner May 12, 2026 12:21
@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f61df384-d99b-426e-be95-da2a9c12a0bf

📥 Commits

Reviewing files that changed from the base of the PR and between 7b10135 and dddf5df.

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

📝 Walkthrough

Walkthrough

This PR updates AGENTS.md to strengthen guidance for AI agents and developers. Line 18 adds an explicit requirement to use git commit --signoff. Lines 97–124 expand the "Code Patterns" section with new subsections: URL .test TLD usage for test domains, Arrange/Act/Assert testing structure, documentation and docstring formatting standards, and a more comprehensive "Commit Messages" section that details DCO sign-off and attribution trailer requirements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and specifically summarizes the main changes: adding DCO sign-off rules, .test TLD usage, backtick formatting conventions, and Sphinx directives to the agents documentation.
Description check ✅ Passed The description is directly related to the changeset, detailing the four specific documentation updates and explaining the rationale for each change.
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.

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


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.

…tting, and Sphinx version directives

- enforce `git commit --signoff` for DCO sign-off (agent was sometimes ignoring the rule)
- use `.test` TLD instead of `example.com` in tests and examples
- use single backticks in markdown/commit messages, double backticks in .rst
- use Sphinx `versionadded`/`versionremoved`/`versionchanged` directives for user-facing changes

Co-Authored-By: Claude <claude@anthropic.com>
Signed-off-by: Christian Heimes <cheimes@redhat.com>
@tiran tiran force-pushed the docs/agents-dco-test-tld-backticks branch from 0beef86 to dddf5df Compare May 12, 2026 12:47
@LalatenduMohanty LalatenduMohanty merged commit 2132ef3 into python-wheel-build:main May 12, 2026
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants