迷ったときや説明が必要なときに引用する先。
- 自走プログラマー 【抜粋版】
- エラーハンドリング、ロギングが書いてある
- レビューの仕方、Pythonのユニットテストも少し書いてある
- 良いコードの書き方
- 初歩寄りのことがいろいろ書いてある
- 名付け方法、コメントの方針、変数のスコープなど
- ダメである理由が無いとこは納得感が薄いかも
- エラーを握りつぶさない。想定外のデータになっている場合は例外を発生させる。
- 🆖 来ることがない値が来た場合に、処理を行わず早期リターンする
- 🆗 来ることがない値が来た場合は例外を発生させる
- そもそもライブラリをアプデしておくのは、脆弱性などがあったときにライブラリを更新しやすいため
- 一方でライブラリを高頻度に更新するのはメンテナー的にはどうしても手間
- 自動PRはGithubでの検索効率を落とすので生産性が逆に下がる(たぶん賛否両論)
よって、追従がめんどくさくなりがちなライブラリのうち一番更新頻度が高いものに合わせて全部更新すると良さそう。 VOICEVOXの場合、エディターのelectronが2ヶ月に1回メジャーアプデなのでこれに合わせるのが良さそう。
- メンテナンス性を下げずにできる範囲で広くサポートする
- Github Actionsのサポートが切れたらサポート対象から外しても良い
- Github Actionsのサポートが切れる半年前からは、何か理由があれば切っても良い
- 同時実行の可能性の考慮
- ユーザーが意識せず同時実行される可能性は考慮する
- 例:音声の自動停止と停止ボタン押下は同時に起こり得る
- ユーザーがほとんどの場合行わない操作による同時実行は考慮しなくても良い
- 致命的な問題が発生することは避けるべきだが、エラーダイアログ表示などの軽いUX低下は許容する
- 例:ショートカットキーとクリック押下は、あまり同時に起こり得ない
- 例:テキスト確定によるAudioQueryの取得完了とテキスト欄の消去は、あまり同時に起こり得ない
- ユーザーが意識せず同時実行される可能性は考慮する