Skip to content

Instantly share code, notes, and snippets.

@YoshiTheChinchilla
Last active August 13, 2019 00:23
Show Gist options
  • Save YoshiTheChinchilla/9f3f0eba4b859306641d638489a6ff05 to your computer and use it in GitHub Desktop.
Save YoshiTheChinchilla/9f3f0eba4b859306641d638489a6ff05 to your computer and use it in GitHub Desktop.
[README-Template.md](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) template in Japanese

プロジェクトタイトル

一段落程度のプロジェクト概要を記載

入門

これらの手順で、あなたのローカルで開発またはテストを目的としたこのプロジェクトのセットアップと実行ができます。どのようにこのプロジェクトをデプロイするのかは後述したデプロイの項目を御覧ください。

前提条件

どのソフトウェアのインストールが必要で、どのようにそれらをインストールするかを記載

コード例

インストール

どのように開発環境を実行するのか、一連の流れの例を記載

手順がどのようになるかを記載

コード例

繰り返す

終了まで

最後に、システムからデータを取得する方法や、デモに使用する例を記載

テスト

このシステムのテスト自動化をどのように動かすかを記載

E2Eテスト

なぜこれらのテストをする理由とテスト対象を記載

コード例

コーディングルールのテスト

なぜこれらのテストをする理由とテスト対象を記載

コード例

デプロイ

どのようにこのシステムをデプロイするのか追記のメモを記載

ビルドシステム

  • Dropwizard - WEBフレームワーク
  • Maven - パッケージマネージャー
  • ROME - RSSフィードの生成

貢献

私たちの行動規範はCONTRIBUTING.mdを読み、プルリクエストをする手順を記載

バージョニング

私たちはバージョン管理のためにセマンティック・バージョニングを使用しています。 利用可能なバージョンについては、タグ一覧を御覧ください

作者

このプロジェクトに参加した貢献者リストも御覧ください。

ライセンス

このプロジェクトはMITライセンスで公開されています。 - 詳細はLICENSE.mdファイルをご覧ください

謝辞

  • 引用や改変元コードの参照
  • インスピレーション
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment