ハード開発向けPull Requestテンプレートを作ってみた

ハードウェアレビュー用のPull Requestテンプレートを作ってみました。これから育てていきたいです。

さかじ

2021.12.24

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちはCX事業本部IoT事業部のさかじです。
私のチームではソース管理はGitHubを使用しています。ハードウェア開発も同様です。ソフトの開発同様回路図などハードウェア開発も非同期でレビュー出来ないかと思いPull Requestのテンプレートを作成してレビューしてみました。

環境

  • Windows10
  • KiCad 5.1.10
  • GitHub

準備

Pull requestテンプレート作成

参考 : Pull Requestのテンプレートを作って効率よくレビューしよう！

ローカルリポジトリの .githubフォルダへ pull_request_template.md を作成しcommitしてリモートリポジトリへpushします。

  • テンプレート
## 機能概要

〇〇回路図作成  
〇〇フットプリント作成  
〇〇アートワーク作成    
〇〇回路図サンプルコード作成  

## 変更点

- [x] 変更点A  
- [ ] 変更点B

## 対象外

## アウトプット

## データシート
データシートのURLなどを記入

## 関連課題

## その他

KiCadデータをGitHubへ

KiCadのデータをgitへ登録、GitHubへpushします。
参考 : KiCadのファイルをgitで管理するとどのように見えるか確認してみた

Pull Request作成

回路図を作成し、commit, pushしてGitHubのリポジトリへ行くとPull Reequestが作成できるようになっています。私はこのように作成しました。

PRイメージ

レビュー

ソースコードのようには修正点へコメントなど書き込むことは出来ませんが、スクショなどを活用して指摘など出来ます。

気をつけたいこと

レビューを依頼する際に、可能な限り非同期で実施したいと思いますので

  • 部品のデータシート
  • 回路設計の方針
  • 注意点

など、Pull Requestのみで完結もしくは軽く説明するだけで伝わるように資料を用意しておくのが良いかと思います。

参考サイト

最後に

テンプレート作ってみたのですがそれほどソフトウェアと項目は変わらないのかなと思いました。実際に運用開始したばかりなので、これから改善点が出てくると思いますが改善して良いテンプレートにしていきたいと思います。

customer-story-analytics