Skip to content

docs: make the Co-Authored-By trailer model-agnostic - #307

Merged
zjshen14 merged 1 commit into
mainfrom
docs/co-author-trailer-model-agnostic
Aug 7, 2026
Merged

docs: make the Co-Authored-By trailer model-agnostic#307
zjshen14 merged 1 commit into
mainfrom
docs/co-author-trailer-model-agnostic

Conversation

@zjshen14

@zjshen14 zjshen14 commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Summary

The git practices mandated Co-Authored-By: Claude Sonnet 4.6, which asked every non-Claude contributor (Codex, Gemini CLI, opencode, …) to either misattribute their work or silently deviate. The trailer still has value (it signals AI-assisted commits to reviewers/future readers), so this keeps it but makes it accurate:

  • docs/engineering-practices.md — the mandate now reads "include a co-author trailer naming the actual assistant + model used", with examples for Claude, Codex, and opencode.
  • docs/task-workflow.md — the commit-message template uses a <assistant/model> placeholder; the two concrete examples now vary across tools (Claude + Codex) to illustrate; the PR template's 🤖 Generated with [Claude Code]🤖 Generated with an AI assistant.

CLAUDE.md and AGENTS.md were checked and contain no literal trailer text, so no sync edit was needed there.

This commit itself uses the new convention (Co-Authored-By: opencode/glm-5.2) as a demonstration.

Test plan

  • npm run typecheck && npm run lint && npm run format:check — clean (docs-only change)
  • grep confirms no unintended hardcoded Claude Sonnet 4.6 / Generated with [Claude Code] references remain (the two kept matches are deliberate examples, now alongside other tools).

The git practices mandated 'Co-Authored-By: Claude Sonnet 4.6', which asked every
non-Claude contributor (Codex, Gemini CLI, opencode, ...) to either misattribute
their work or silently deviate. Generalize the rule: AI-assisted commits must
include a Co-Authored-By trailer naming the ACTUAL assistant + model used, with
examples for several tools. The task-workflow commit examples now vary across
tools to illustrate this, and the PR template's tool-specific line is neutralized.

Co-Authored-By: opencode/glm-5.2 <noreply@opencode.ai>
@zjshen14
zjshen14 merged commit 3beed63 into main Aug 7, 2026
3 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.

1 participant