docs(agents): add rules for DCO sign-off, .test TLD, backtick formatting, and Sphinx version directives#1144
Conversation
|
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ 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. Comment |
…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>
0beef86 to
dddf5df
Compare
Pull Request Description
What
git commit --signofffor DCO sign-off (agent was sometimes ignoring the rule).testTLD instead ofexample.comin tests and examplesversionadded/versionremoved/versionchangeddirectives for user-facing changesWhy
Agent was sometimes ignoring the
--signoffrule. I have to remind the agent of.testTLD, backtickets and Sphinx directives regularly.