0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

Gitbucket、Githubでプルリクエストのテンプレートを設定する

Last updated at Posted at 2020-09-07

GitBucketにプルリクエストを作成する際、
手動で確認事項を書き忘れたことが発生してしまいましたので、
プルリクエストのテンプレートを設定する方法を調査しました。
その設定メモを残ります。

プルリクエストのテンプレート作成

前提条件として、Gitのリポジトリを用意しています。

作成方法は以下の二つがあります。

方法①

リポジトリのルートディレクトリにテンプレートファイルを配置する

例:pull_request_template.md

ファイルの中:
## 概要
このプルリクエストは、「どういう作業、変更を行う」を記載。

## テスト方法、確認した内容
テストした内容や、確認した内容を記載。

## TODO
このPull Requestに対して、後続で発生する積み残し作業などがある場合は記載。

これで、テンプレートを設定できました。
新しいプルリクエストを作成する際、上記のテンプレートが生成されると思います。

Githubの方は、サンプル1を用意しましたので、ご参考まで。

方法②

リポジトリの特定のフォルダ配下に、テンプレートファイルを配置する

GitBucketの場合、「.gitbucket」フォルダにコピー
Githubの場合、「.github」フォルダにコピー

Githubの方は、サンプル2を用意しましたので、ご参考まで。

どちらでもテンプレートを設定できますが、テンプレートファイルの探す優先順位として、
方法① > 方法②

Githubのドキュメントに設定の詳細があります。
https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

0
1
4

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?