READMEを作成する

9月 30, 2020 admin 0 Comments

良いREADMEのための提案

すべてのプロジェクトは異なるので、これらのセクションのどれがあなたに当てはまるかを の部分のテンプレートは、あくまでも提案でほとんどのオープンソースのソフトウェア. また、READMEは長すぎて詳細になる可能性がありますが、短すぎるよりも長すぎる方が優れていることに注意してください。 READMEが長すぎると思われる場合は、情報を切り取るのではなく、別の形式の文書を利用することを検討してください。

Name

プロジェクトの自己説明的な名前を選択します。,

Description

あなたのプロジェクトが具体的に何ができるかを人々に知らせてください。 コンテキストを提供し、訪問者が不慣れである可能性のある参照へのリンクを追加します。 フィーチャのリストまたは背景サブセクションもここに追加できます。 あなたのプロジェクトに代わるものがある場合は、差別化要因を列挙するのに適しています。

バッジ

一部のReadmeでは、すべてのテストがプロジェクトに合格しているかどうかなど、メタデータを伝える小さな画像が表示されることがあります。 シールドを使用して、READMEにいくつかを追加することができます。 多くのサービスも指示を追加バッジ”に登場します。,

Visuals

作っているものに応じて、スクリーンショットやビデオを含めることをお勧めします（実際のビデオではなくGifを頻繁に見ることができます）。 Ttygifのようなツールが役立ちますが、より洗練された方法についてはAsciinemaをチェックしてください。

インストール

特定のエコシステム内では、Yarn、NuGet、またはHomebrewを使用するなど、物事をインストールする一般的な方法があるかもしれません。 ただし、READMEを読んでいる人は誰でも初心者であり、より多くのガイダンスを希望する可能性を考慮してください。, 上場認定を削除曖昧さが人ご利用プロジェクトとして速やかに対応いたします。 特定のプログラミング言語バージョンやオペレーティングシステムなどの特定のコンテキストでのみ実行される場合、または手動でインストールする必

使用法

例を自由に使用し、可能であれば期待される出力を表示します。 READMEに合理的に含めるには長すぎる場合は、より洗練された例へのリンクを提供しながら、実証できる最小の使用例をインラインにすると便利です。,

サポート

彼らは助けを求めに行くことができる場所を人々に伝えます。 課題トラッカー、チャットルーム、メールアドレスなどの任意の組み合わせにすることができます。

ロードマップ

将来のリリースのアイデアがある場合は、READMEにリストすることをお勧めします。

Contribution

あなたが貢献に開いていて、それらを受け入れるためのあなたの要件が何であるかを述べてください。

あなたのプロジェクトに変更を加えたい人のために、開始する方法についてのいくつかのドキュメントを持っていることは役に立ちます。, おそらく、実行する必要があるスクリプトや、設定する必要がある環境変数があります。 これらの手順を明示的に行います。 これらの指示は、あなたの将来の自己にも役立ちます。

また、コードをlintまたはテストを実行するためのコマンドを文書化することもできます。 これらの手順は、高いコード品質を確保し、変更が誤って何かを壊す可能性を減らすのに役立ちます。 この指示を走行試験では特に役に立するにあたっては外部設定など、セレンのサーバーのための試験である。,

著者と謝辞

プロジェクトに貢献した人にあなたの感謝を示してください。

License

オープンソースプロジェクトの場合、どのようにライセンスされているかを言います。

Project status

プロジェクトのエネルギーや時間が足りなくなった場合は、READMEの上部に開発が減速または完全に停止したことをメモしてください。 誰かがあなたのプロジェクトをフォークするか、メンテナまたは所有者としてステップインするボランティアを選択することがで また、メンテナに対して明示的な要求を行うこともできます。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です