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

  • Select an option

    Learn more about clone URLs
  • Save tomill/083952e876249315c7c4aa6c38e1d61f to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
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

  • あまり書きすぎずネタに走らず追記事項があれば書く
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment