Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
社内のレポジトリのreadmeテンプレ

プロジェクト名(サーバー名やバッチ名)

タイトルだけだとわからない場合は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
You can’t perform that action at this time.