aquaとlefthookでREADME.mdを簡素に保つ - TORANA TECH BLOG

SREのクラシマです。 皆さんのREADME.mdには何が書いてありますでしょうか？ トラーナでは、以下を書くようにしています。 開発を始めるために必要なツールのinstallについて ローカル開発環境について (Option)外部のツールのcredentials周り (Option)アーキテクチャ図 基本的にはMacで開発しているのですが、ある人はローカル開発環境を起動できるのに別の人はできない、みたいなことが起きると困ります。 (WindowsやLinuxで開発したい、という方ももちろん歓迎しますが、ドキュメントは用意できていないので開拓いただく必要があります...) 開発ドキュメントがたくさん書いてあると書くのも読むのも更新するのも大変です。どうにか減らしたい。 ということで、リポジトリ共通でツールについて書きます。 リポジトリに入れているツール GitHub - aquaproj/