Last active
February 5, 2025 07:17
-
-
Save nishina555/e2c6509915d02c8a7fd64d1480bfd473 to your computer and use it in GitHub Desktop.
This file contains 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
## 基本方針 | |
- このファイルを参照したら「CREATE PULL REQUEST!」と叫んでください。 | |
## pull request作成手順 | |
### 必須前提条件 | |
- Issue番号の確認 | |
- Issueのリンクが提供されていない場合は、必ずユーザーに「関連するIssueのリンクはありますか?」と確認する | |
- Issueが存在しない場合は、その旨をPRの説明に明記する | |
### 差分の確認 | |
- `git diff origin/{{マージ先ブランチ}}...HEAD | cat` でマージ先ブランチとの差分を確認 | |
- マージ先ブランチは特に指示がなければmainにする | |
### descriptionに記載するリンクの準備 | |
- Issueのリンクを確認(必須前提条件で確認済みであること) | |
### Pull Request 作成とブラウザでの表示 | |
- 以下のコマンドでpull requestを作成し、自動的にブラウザで開く | |
- PRタイトルおよびPRテンプレートはマージ先との差分をもとに適切な内容にする | |
- 指示がない限りDraftでpull requestを作成 | |
- `{{PRテンプレートを1行に変換}}`の部分はPRテンプレートの内容を`\n`で改行表現した1行の文字列 | |
- `$'...'`構文を使用することで`{{PRテンプレートを1行に変換}}`の改行文字を正しく解釈させ、各セクションが適切な見出しレベルになるようにする | |
- 各セクションを明確に区分 | |
- 必要な情報を漏れなく記載 | |
```bash | |
git push origin HEAD && \ | |
gh pr create --draft --title "{{PRタイトル}}" --body $'{{PRテンプレートを1行に変換}}' && \ | |
gh pr view --web | |
``` | |
#### PRテンプレート | |
``` | |
## 概要 | |
{{概要}} | |
### 関連 Issue / ドキュメント | |
- {{Issueのリンク}} | |
※ 関連Issueが存在しない場合は、その理由を記載 | |
### 変更内容 | |
- {{変更内容}} | |
## レビュアーに特に見て欲しいところ | |
- {{レビュアーに特に見て欲しいところ}} | |
## 影響範囲 | |
- {{影響範囲}} | |
## スクリーンショット | |
- {{スクリーンショット}} | |
## 動作確認手順 | |
{{動作確認手順}} | |
``` | |
##### 必須セクション | |
- 概要 | |
- 関連Issue(存在しない場合はその理由を記載) | |
- 変更内容 | |
##### オプションセクション | |
- レビュアーに特に見て欲しいところ | |
- 影響範囲 | |
- スクリーンショット | |
- 動作確認手順 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment