コツアreadmeファイル、なぜその重要

月19日 2020年·6分読み

また、開発者、 非常に良いコードのすべての分の詳細は当社ます。 の一環で（私）がソフトスキルの中でもオンライン-コミュニティ,

開発者は、単一のボタンのパディングとマージンを調整する時間を費やすことになります。 しかし、プロジェクトの説明Readmeファイルに15分を惜しまないでしょう。

私はあなたのほとんどがすでに何を知っていることを願っていますreadme.md ファイルとは何か。 しかし、ここで初心者のために、私はそれが正確に何であるかを説明しようとします。

aとは何ですかReadme.md?

README（名前が示すように：”read me”）は、新しいプロジェクトを開始するときに読むべき最初のファイルです。, これは、プロジェクトと一種のマニュアルに関する有用な情報のセットです。 このファイルのGithubの他のGitスサイトを見た人が開設サポート..

きくちらのReadme.mdファイルのルートのリポジトリが自動的に表示すgithub以下のプロジェクトをクリックします。

そして.md拡張子は、markdownという単語から来ています。, テキスト書式設定のマークアップ言語です。 HTMLと同じように、文書を見やすくするためのマークアップ言語です。

これはmarkdownファイルの例であり、実際にgithubでどのようにレンダリングされるかを示しています。 Markdownファイルのプレビューを同時に表示するプレビューには、ここでVSCodeを使用します。

ここでは、マークダウン形式の公式Githubチートシートです。あなたは言語の奥深くに住む必要があります。

今、ビジネスを話しましょう。, あなたはプロジェクトに何時間も費やし、GitHubで公開し、人々/採用担当者/同僚/（Ex？）プロジェクトを参照。 あなたは本当に彼らがあなたの美しいロジックを見るためにroot/src/app/main.jsに入ると思いますか？ マジで？

あなたの注意を引いたので、これに取り組む方法を見てみましょう。

コンポーネントのドキュメントの生成

プロジェクトのreadmeに加えて、コンポーネントのドキュメント化は、分かりやすいコードベースにとって重要です。 いや再利用部品を維持します。, 使用ツールのようにビット(Github)を自動生成文書の部品の共有ます。dev

例:ビットで共有されるコンポーネントを検索します。dev

あなたのプロジェクトを記述します！ (TL;DR)

あなたのプロジェクトの良い説明を書いてください。 –

  • タイトル（可能であればタイトル画像も…canvaで編集してください。,comグラフィックデザイナーでなければ。デモ（画像、ビデオリンク、ライブデモリンク）
  • 使用される技術
  • あなたのプロジェクトの特別な問題（あなたが直面した問題、あなたのプロジェクトのユニークな要素）
  • あなたのプロジェクトの技術的な説明のような-インストール、セットアップ、貢献する方法。

専門性に深く飛び込みましょう

私は私が書いた最も美しいreadmeファイルの一つを持っていると思う参照として私のこのプロジェク, のコードをチェックアウトできますReadme.md 鉛筆アイコンを使用してマークダウンコードを表示します。-

画像を追加！ お願い！

写真のメモリがあるかもしれませんが、読者はプロジェクトのデモの実際の写真が必要な場合があります。

たとえば、solitaireプロジェクトを作成し、readmeに説明として画像を追加しました。,

Now you may want to add a video description of your projects too. Just like I did. BUT… Github doesn’t let you add a video to the readme… So… So what?

…WE USE GIFS

HAHA… Got ya Github.,

Gifは画像のカテゴリに分類され、githubではreadmeにそれらを持つことができます。

名誉のバッジ

readmeのバッジは、視聴者に信憑性を感じさせます。, -https://shields.io