PR 결정하기
이 스킬이 호출되면 업데이트할 PR을 명시적으로 지정할 수 있지만, 일반적인 경우 사용자가 현재 작업 중인 브랜치/커밋에서 PR을 추론합니다. 일반 Git 사용(아래 Sapling 제외)의 경우 git branch와 gh pr view <branch> --repo openai/codex --json number --jq '.number'를 조합하여 현재 브랜치/커밋과 연결된 PR을 확인해야 할 수 있습니다.
PR 본문 내용
호출 시 gh를 사용하여 PR 본문과 제목을 지정된 PR 내용에 맞게 편집합니다. 기존 PR 본문에 보존해야 할 중요한 정보가 있는지 반드시 확인하세요. 예를 들어, 기존 PR 본문에 있는 이미지를 절대 제거하지 마십시오. 작성자가 복구할 방법이 없을 수 있습니다.
변경이 이루어진 _이유_를 설명하는 것이 매우 중요합니다. 현재 이 스킬이 호출된 대화에서 동기가 논의된 경우, 이를 PR 본문에 반드시 포함하세요.
본문에는 무엇이 변경되었는지도 설명해야 하지만, 이는 이유 뒤에 나와야 합니다.
커밋의 _순 변경(net change)_에 대해서만 논의하세요. PR 개발 과정에서 시도했다가 나중에 되돌린 변경 사항에 대해 논의하는 것은 일반적으로 좋지 않습니다. PR 본문을 다시 작성할 때, 더 이상 적절하지 않거나 미래의 독자에게 관심이 없는 세부 사항은 제거해야 할 수 있습니다.
로컬 디스크의 절대 경로 참조를 피하세요. 리포지토리 내의 경로에 대해 이야기할 때는 단순히 리포지토리 상대 경로를 사용하세요.
코드네임, OpenAI 내부 URL 등 기밀 정보에 대한 참조를 피하세요.
변경 사항이 어떻게 검증되었는지 논의하는 것이 일반적으로 유용합니다. 그러나 CI가 자동으로 확인하는 사항(예: just fmt 실행 여부)을 언급할 필요는 없습니다. 다만 PR로 도입된 새 동작을 검증하기 위해 의도적으로 추가된 새로운 테스트를 식별하는 것은 종종 적절합니다.
PR을 전문적으로 포맷하려면 Markdown을 활용하세요. 코드 관련 내용은 인라인에서 참조될 때 단일 백틱으로 표시하세요. 코드를 참조하거나 셸 트랜스크립트를 표시할 때는 펜스 코드 블록이 유용합니다. 또한 변경과 관련된 기존 코드를 인용할 때는 GitHub 영구 링크를 사용하세요.
관련 PR이나 이슈가 있으면 반드시 참조하되, 자신의 PR 본문에서 해당 PR 자체를 참조할 필요는 없습니다.
이 변경의 결과로 https://developers.openai.com/codex 의 문서를 업데이트해야 한다면, PR 끝 부분에 별도 섹션으로 명시하세요. 업데이트해야 할 문서가 없으면 이 섹션은 생략하세요.
스택 작업
때로는 PR이 서로를 기반으로 하는 커밋 스택으로 구성됩니다. 이러한 경우 PR 본문은 스택을 구성하는 개별 커밋이 아닌 스택 전체가 도입하는 _순 변경_을 반영해야 합니다.
마찬가지로, 사용자가 Sapling 같은 도구를 사용하여 _스택형 풀 리퀘스트_를 사용하는 경우, PR의 base는 main이 아니라 스택에 있는 다른 PR의 head 브랜치일 수 있습니다. 이 경우 main에 대한 변경이 아닌, 스택 베이스에 대해 열리는 PR의 base와 head 사이의 순 변경만 논의해야 합니다.
Sapling
.git/sl/store가 존재하면, 이 Git 리포지토리는 Sapling SCM(https://sapling-scm.com)이 관리합니다.
Sapling에서 현재 리비전과 연결된 GitHub 풀 리퀘스트가 있는지 확인하려면 다음을 실행하세요:
sl log --template '{github_pull_request_url}' -r .
또는 sl sl을 실행하여 현재 개발 브랜치와 현재 커밋에 연결된 GitHub PR이 있는지 확인할 수 있습니다. 예를 들어, 출력이 다음과 같다면:
@ cb032b31cf 72 minutes ago mbolin #11412
╭─╯ tui: show non-file layer content in /debug-config
│
o fdd0cd1de9 Today at 20:09 origin/main
│
~
@는 현재 커밋이cb032b31cf임을 나타냅니다.origin/main에서 분기된 단일 커밋으로 구성된 개발 브랜치입니다.- GitHub 풀 리퀘스트 #11412와 연결되어 있습니다.