見出し画像

Githubにプルリクエストのテンプレートを作成する方法

Githubにはプルリクエストのテンプレート機能があるようなので利用してみました。テンプレートを作成することで、複数で開発していてもプルリクエスト の書き方が統一できるので便利です。

※今回はGithub上でディレクトリとファイルを作成する方法を説明します。

それではプルリクエストのテンプレート作成方法を説明します。


Githubにプルリクエストテンプレートを作成する方法

目次
1. create new file ページへ移動
2. 「.github」 ディレクトリを作成
3. 「PULL_REQUEST_TEMPLATE.md」 ファイルを作成


1. create new file ページへ移動

Githubの「<>code」ページより、「Create new file」をクリックします。


2. 「.github」 ディレクトリを作成

テキストフィールドに「.github/」と入力します。
すると、「.github」ディレクトリが作成されます。


3. 「PULL_REQUEST_TEMPLATE.md」 ファイルを作成

先ほど作った「.github」ディレクトリ内にPULL_REQUEST_TEMPLATE.md を作成します。

テキストフィールドに「PULL_REQUEST_TEMPLATE.md」と記載し、
Edit new fileにはテンプレート内容を記載します。

記載したら画面下部の「Commit new file」をクリックします。

これでファイルが作成されました。


以上です。

最後に

プルリクエストですが、大勢で開発を行っていると作業者によって書き方が異なってきます。
書き方が上手い人もいれば、一言しか書かない人もいる。
しかしながら、レビュアーとしてはそれぞれ別の書き方で書かれると見にくくなってしまいます。また、なるべく丁寧に書いて欲しいというのもあります。
ただ、レビュイーとしてもなるべく開発に時間をかけたいので、プルリクエストにそこまでこだわりたくないというのも理解できます。

ということで、そういったときにテンプレートを用意しておけばレビュアー、レビュイー共に便利だし楽かなと思います。
また、基本的にプルリクエストに書いて欲しい内容というのは決まっているので、テンプレートがあれば統一できてとても良いですね。

ということで良いことしかないテンプレート機能。皆さんも是非利用して見てください。



この記事が気に入ったら、サポートをしてみませんか?気軽にクリエイターを支援できます。

note.user.nickname || note.user.urlname

読んでいただきありがとうございます!『スキ』を押してもらうと、長野県松本市のおすすめカフェを紹介します!

『珈琲茶房 かめのや』昔ながらのレトロな喫茶店です
3
長野県松本市のWeb制作会社 Res, Inc. 代表 / Web ディレクター(IAが得意)、エンジニア(Laravel/PHP/MySQL/Nuxt.js/Vue.js/ Contentful/Netlify/Drupal/Wordpress)

この記事が入っているマガジン

コメントを投稿するには、 ログイン または 会員登録 をする必要があります。