lywsvip/DeepSeek-TUI
1
0
Fork 0
mirror of https://github.com/Hmbown/DeepSeek-TUI.git synced 2026-09-03 06:50:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: require rebase/merge-commit (not squash) for harvested PRs (#3533)

Browse Source 
A squash-merge rewrites the commit body, so it can drop the
`Harvested from PR #N by @author` line a harvest commit carries. When that
line never reaches `main`, both the machine-readable contributor credit and
the auto-close-harvested workflow silently fail - the exact credit-drop
class #3517 had to reconcile after the fact.

The credit gate (scripts/check-coauthor-trailers.py) runs on every PR and
push to main, but it can only validate a marker that survives; it cannot
detect one a squash already deleted. Merge method is the missing guardrail,
so document it in the two canonical places:
- AGENTS.md: extend the harvesting-credit rule.
- CONTRIBUTING.md: refine the "maintainers may squash or harvest" note.
This commit is contained in:
Hunter Bown
2026-06-23 20:14:04 -07:00
committed by GitHub
parent 33ac33c522
commit c75b8967b4
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
AGENTS.md
View File

@@ -93,7 +93,10 @@
author where possible, add `Co-authored-by` using `.github/AUTHOR_MAP` or
GitHub numeric noreply identity, and include `Harvested from PR #N by
@handle` in the commit body so the auto-close workflow can close the PR with
credit after it reaches `main`.
credit after it reaches `main`. Merge a PR whose commit carries that line
with rebase or a merge commit, never squash: a squash can rewrite the body,
drop the `Harvested from PR` line, and silently lose both the
machine-readable credit and the auto-close.
- Never add bot/tool `Co-authored-by` trailers (Claude, codex, cursor,
`noreply@anthropic.com`): `scripts/check-coauthor-trailers.py` rejects them on
harvest commits — contributor trailers are for humans. Also refresh the manual

5
CONTRIBUTING.md
View File

@@ -162,7 +162,10 @@ dependent layers. For those changes, use this workflow:
but leaves follow-up work.
7. Structured commits are fine during review. Maintainers may squash or harvest
at merge time, with contributor credit preserved through authorship,
co-author trailers, changelog entries, or PR/issue comments.
co-author trailers, changelog entries, or PR/issue comments. When the merge
commit itself carries a `Harvested from PR #N by @author` line, that PR is
merged with rebase or a merge commit rather than squashed, so the line
reaches `main` intact and the auto-close credit fires.
Before asking for merge review on a layered PR, check that it is: