Skip to content

Instantly share code, notes, and snippets.

@tomill

tomill/internal-repo-readme-boilerplate.md

Created December 25, 2019 12:19
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tomill/083952e876249315c7c4aa6c38e1d61f to your computer and use it in GitHub Desktop.
Save tomill/083952e876249315c7c4aa6c38e1d61f to your computer and use it in GitHub Desktop.
Download ZIP
社内のレポジトリのreadmeテンプレ
Raw
internal-repo-readme-boilerplate.md

プロジェクト名（サーバー名やバッチ名）

タイトルだけだとわからない場合は1行説明

Overview



なんか
すごい
わかった気になる
図
  • hoge
  • fuga

Development

Prereq

Setup

make deps

Run

make run

Test

make test

Production

  • どこでどのようにいつうごいているのか
  • 確認方法のリンク先
  • アラートの送信先

Deploy

  • デプロイ方法かCDツールへのリンク

Notes

  • あまり書きすぎずネタに走らず追記事項があれば書く
@tomill
Copy link
Author

tomill commented Dec 25, 2019

ブログにかいた→

https://tomi-ru.hatenablog.com/entry/2019/12/25/%E7%A4%BE%E5%86%85%E3%81%AE%E3%83%AC%E3%83%9D%E3%82%B8%E3%83%88%E3%83%AA%E3%81%AEreadme%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment