🐙

GithubのTemplateを使おう

2022/08/08に公開

GitHub

tech

Issue Template

まずはGithubのSettingsをクリックします

FeaturesのIssuesの「Set up templates」をクリックします

ドロップダウンをクリックして、テンプレートを選択します
「Bug Report」を選択しましょう

Propose changesをクリックします

Commit changesをクリックします

これで完了です、レポジトリーには.github/ISSUE_TEMPLATE/bug_report.mdというファイルが生成されました

新しいIssueを開くと、用意されたテンプレートがあります

Issue Formも使いましょう

.github/ISSUE_TEMPLATE/hotbug_report.ymlというファイルを作成します

内容はこ書きます

.github/ISSUE_TEMPLATE/hotbug_report.yml

name: Hot Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
  - octocat
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: Also tell us, what did you expect to happen?
      placeholder: Tell us what you see!
      value: "A bug happened!"
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: What version of our software are you running?
      options:
        - 1.0.2 (Default)
        - 1.0.3 (Edge)
    validations:
      required: true
  - type: dropdown
    id: browsers
    attributes:
      label: What browsers are you seeing the problem on?
      multiple: true
      options:
        - Firefox
        - Chrome
        - Safari
        - Microsoft Edge
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      render: shell
  - type: checkboxes
    id: terms
    attributes:
      label: Code of Conduct
      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
      options:
        - label: I agree to follow this project's Code of Conduct
          required: true

Issue Formの書き方はこちらを参照してください

そしてコミットしてプッシュします

Issueを開くと、綺麗なフォームができています

フォームを記入して、Submitすればこういう感じになります

Pull Request Template

.github/pull_request_template.mdというファイルを作成します

その中にこのように記入します

.github/pull_request_template.md

## Ticket / Issue Number

チケット番号などを記入してください

（記入例：#3）

## What's changed

このプルリクは何をしたのかを記入してください。画像とテキストを使って説明するのがおすすめです。

* ホームページのUIを調整しました
* Primary Colorを`#0969DA`へ変更しました（@ianchen0419 確認お願いします）
* Bugを修復しました :+1:
* デプロイしました（[デプロイ先](https://pages.github.com/)）

## Todo List

今回のプルリクはまだやっていないことや、将来やる予定の事項を記入してください

- [x] デザイナーに確認してもらいます
- [ ] iOS 16のデバイスにテストします
- [ ] テストケースを書きます

## Check List

- [x] ESLintはエラーや警告は出ませんでした
- [x] `npm run build`を使ってエラーは出ませんでした
- [ ] Storybookを確認しました
- [ ] iPhone Safariで画面を確認しました
- [ ] Android Chromeで画面を確認しました
- [ ] 相応したテストケースを書きました

## Remark

補足事項があれば記入してください

そして、コミットしてプッシュします

早速PRしてみます、テンプレートが出ました

Submitしたらこんな感じになりました

Issue Template

Issue Formも使いましょう

Pull Request Template

Discussion