[skip deploy] docs(agents): specify Chinese PR descriptions - #118
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
使用者遇到的問題
看 PR 的人拿到的敘述語言不固定。
AGENTS.md的語言規則規定 commit message 與 issue/PR 標題用英文,但沒有規定 PR 內文,所以同一個 repo 的 PR 內文有中文也有英文。還有一件更麻煩的:
## PR 敘述怎麼寫那一段對 Claude Code 來說根本不存在。背景
這個 repo 的
CLAUDE.md跟AGENTS.md是兩份獨立的檔案,內容大致相同。Claude Code 讀CLAUDE.md,Codex 讀AGENTS.md。上一個 PR(#117)把## PR 敘述怎麼寫只加進AGENTS.md,CLAUDE.md沒有跟著改,兩份就此分岔。問題出在哪裡
git show main:CLAUDE.md出來的第一段是這樣:整份 48 行裡沒有
## PR 敘述怎麼寫。AGENTS.md有,CLAUDE.md沒有。平常看不出來是因為兩份檔案內容幾乎一樣,diff 只有在改動之後才會分開,而改動當下沒有人會同時打開兩份對照。修法
語言規則加一條,把內文與標題分開:
標題維持英文,因為它跟 conventional commit 格式綁在一起,也是之後在 GitHub 上被搜尋的那一行。
## PR 敘述怎麼寫開頭再寫一次同一件事:只寫在語言規則清單裡,寫 PR 的 agent 不一定會讀到那一段。第二個 commit 把
CLAUDE.md換成指向AGENTS.md的 symlink,跟 wspc 一致,並在AGENTS.md開頭註明哪一份是正本。這一步看起來跟這次的改動無關,但省掉的話這次加的規則對 Claude Code 一樣看不到,等於白做。刪掉的
CLAUDE.md內容確認過沒有AGENTS.md缺的東西:唯一的差異是README.md / DEVELOPER.md / CLAUDE.md那一行在AGENTS.md版本結尾多了/ AGENTS.md。這個 PR 不修什麼
沒有幫既有的 PR 補中文敘述,只規範之後開的。
這個 repo 沒有驗收報告那套設定(沒有
.claude/rules/acceptance-report.md,也沒有docs/acceptance-reports/),所以沒有加「PR 要連驗收報告」那一條。有那套設定的是 wspc,對應的 PR 是 sadcoderlabs/wspc#1121。測試
文件改動,沒有測試。手動確認
CLAUDE.md換成 symlink 之後讀得到AGENTS.md的完整內容,且 git 記錄的 mode 是120000。