Help us understand the problem. What is going on with this article?

良い を書くためのテンプレート(翻訳)

More than 1 year has passed since last update.

GitHub Gist でBillie Thompson さん が公開している 良い を書くためのテンプレート | A template to make good という Gist が良さそうだったので日本語に翻訳しました。

このマークダウン文書は、オープンソースプロジェクトの をテンプレート化したもので、プロジェクトの概要説明から開発環境の立ち上げ、貢献方法への案内などを簡潔にまとめる方法が書かれています。オープンソースのライブラリを公開するときなどにコピーして使うと良さそうです。


Project Title / プロジェクトのタイトル

One Paragraph of project description goes here
プロジェクトの概要を 1 段落でここに書きます

Getting Started / スタートガイド

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites / 必要条件

What things you need to install the software and how to install them

Give examples

Installing / インストール

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests / テストの実行

Explain how to run the automated tests for this system

Break down into end to end tests / e2e テストまで詳解する場合

Explain what these tests test and why

Give an example

And coding style tests / それからコーディングスタイルのテスト

Explain what these tests test and why

Give an example

Deployment / デプロイ

Add additional notes about how to deploy this on a live system

Built With / 協働するシステムのリスト

  • Dropwizard - The web framework used / 使用した web フレームワーク
  • Maven - Dependency Management / 依存関係管理ソフトウェア
  • ROME - Used to generate RSS Feeds / 使用した RSS フィード生成

Contributing / コントリビューション

Please read for details on our code of conduct, and the process for submitting pull requests to us.
私たちのコーディング規範とプルリクエストの手順についての詳細は を参照してください。

Versioning / バージョン管理

We use SemVer for versioning. For the versions available, see the tags on this repository.
私たちはバージョン管理に SemVerを使用しています。利用可能なバージョンはこのリポジトリのタグを参照してください。

Authors / 著者

  • Billie Thompson - Initial work / 原著者 - PurpleBooth

See also the list of contributors who participated in this project.

License / ライセンス

This project is licensed under the MIT License - see the file for details
このプロジェクトは MIT ライセンスの元にライセンスされています。 詳細はLICENSE.mdをご覧ください。

Acknowledgments / 謝辞

  • Hat tip to anyone whose code was used / コードを書いた人への感謝
  • Inspiration / 何からインスピレーションを得たか
  • etc / その他
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away