開発者ブログ — 第5部 — リードミー

開発者ブログ — 第5部 — リードミー

スタジオメディアの写真
それは私がシリーズにエントリを追加して以来、しばらくの間、過去数ヶ月のために、主にちょうど送信されたバグを介して作業されており、小さな機能を追加!しかし、いくつかの会話の後に、私は私がReadMeファイルを通して働くために思考プロセスを説明しているもう一つのエントリを加えるとわかりました.
良いREADMEは、プロジェクトの意図と提案されたソリューションの基本的な説明を与えることができるだけでなく、どのようにアプリケーションに貢献を開始する簡単なガイドを与える
この短いブログ記事を読んでいる間、それをチェックするために、READMEがここにあります.

ステータスチェック
私のReadMeの非常にトップでは、私は私のアプリに関連付けられているいくつかのサードパーティのライブラリのいくつかの迅速なステータスバッジを残しに選んだ.
codecov
私はこのアプリの健康のかなり甘い概要を与えるように感じる!
cypress
アバウト
私はこのセクションを二つのセクションに分けました.アプリの主な機能のクイックリストとどのようにGIFとスクリーンショットのセクション'作品!私はこれらのスクリーンショットは、アプリケーションが動作する方法のはるかに具体的なビューを与えるように感じる.これらはcodeqlとnetlifyを使用してかなり簡単にフックすることができます.
私は必要なGIFとイメージをアップロードして、単にMarkdownを通してそれらをリンクします:

<!-- Example Gif --> 
![til](https://media.giphy.com/media/ncqqOirC9cs0ivsM0n/giphy.gif) 

<!-- Example Image --> 
![Imgur Image](https://i.imgur.com/viBwwxQ.png)

クイックスタート
その後、私は他の貢献者がすぐに次のセクションでアプリケーションを起動するのを助けるいくつかのセクションを含みます:

前提条件-私は速く

を始めるために、CLIコマンドをすぐにレイアウトします

テストの実行 — コマンドをダブルチェックするために必要なコマンドは、すべてがまだ大丈夫

を確認します

ロードマップ — ちょっとのセクションは、どんな問題が

で働いているかについてわかっているために、Githubリポジトリのために問題ページにリンクします

の展開 — プロジェクトがNetLify

に配備される方法についての簡単な概要

バージョン管理 — バージョニングの仕組みの説明.この場合、それは産業規格

であるように、Semverが使われます
Imgur
貢献
これはおそらく私のケースでは、貢献することができます全体のREADMEのより重要なセクションの1つ、貢献している.MDは、プロジェクトに貢献する方法の詳細について説明します.
GiTubは、一般的な形式を助けることができるが、私はあなたのプロジェクトにそれぞれの調整を行うことをお勧めします.
理想的には、このセクションでは、メソッドの処理に必要な特別な手順を参照してください.
giphy
雑多な
最後に、私は小さなセクションを私に連絡することができるだけでなく、いくつかの法的情報として、アプリケーションのポケモンは、自然の中で関連している.
そして、それ!あなたがREADMEについて何を考えているか、あるいは、あなたがあなたのプロジェクトのReadmesに含まれる他の詳細があるならば、私に知らせてください
元来は2022年1月9日にで発行された.