Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zjshen14 merged 1 commit into from
Aug 7, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/engineering-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,14 @@ Current docs:

**Never commit secrets.** `.env` is gitignored. API keys go in `.env` only. Run `git diff --cached | grep -i "AIza\|api_key\|secret"` before committing if unsure.

**Always include the co-author trailer:**
**Always include a co-author trailer on AI-assisted commits**, naming the actual
assistant and model that produced the change. This keeps the human- vs. AI-authored
audit trail accurate for reviewers and future contributors. Use the real tool +
model — do not attribute work to a tool that wasn't used.
```
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: opencode/glm-5.2 <noreply@opencode.ai>
```

---
Expand Down
8 changes: 5 additions & 3 deletions docs/task-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,11 @@ API keys go in `.env` only (which is gitignored).
<optional body explaining why, not what>

Closes #<issue_number>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: <assistant/model> <noreply@...>
```

Name the **actual** assistant + model used (see [Engineering Practices → Git](engineering-practices.md#git-branching--issue-management)). Don't hardcode a tool you didn't use.

Examples:
```
fix: skip orphaned tool_result entries instead of silently producing corrupt Message[]
Expand All @@ -117,7 +119,7 @@ refactor: extract duplicate retry loop into shared withRetry utility
Reduces duplication across Gemini, Anthropic, OpenAI clients without changing behavior.

Closes #75
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Codex <noreply@openai.com>
```

**Use `Closes` if the commit fully resolves the issue.** Use `Part of` or `References` if it's partial work.
Expand Down Expand Up @@ -168,7 +170,7 @@ This keeps the issue as the canonical record of progress and makes it easy to re
- [ ] <manual testing steps if UI/behavior changes>
- [ ] <edge cases or regressions to check>

🤖 Generated with [Claude Code](https://claude.com/claude-code)
🤖 Generated with an AI assistant
```

**What to explain in the description:**
Expand Down