こんにちは初心者です。
オープンソースへの道を作ることにおめでとうございます。 それは偉大なコミュニティです。
それは最初に少し混乱しています。 どのように貢献するか、どこに貢献するか、問題、バグ、PR、PR、PR！
あなた自身がオープンソースに関与するように、あなたはそれをすべて学びます、心配しないでください。
しかし今日したいと思っていますすべてのアドバイスもしいパスワードを入力してくださ始めたときに私のオープンソースです。
私はオープンソースに貢献し、少し前にすべての私の小さなサイドプロジェクトをGitHubに置き始めました。, 当時、私はREADMEの部分について知りませんでした。 時間が経過し、私はいくつかのkickass開発者に従い始めました。 間違いなく、彼らはすべて素晴らしいプロジェクトを持っていましたが、最も一般的なことは、すべてのプロジェクトが素晴らしいREADMEを持っていまし
やめろ！! 私はあなたのオープンソースの旅について読むことに興味 良いREADMEを書く方法について教えてください。
クール。 だからここに行く—
GitHubにあなたの素晴らしいプロジェクトを置く前に、私はあなたが最初にReadme駆動開発について読んでほしいです。,
READMEを気にする必要があるのはなぜですか？
オープンソースコミュニティは急速に成長しています。 開発者にリリース新規オープンソースプロジェクトGitHubの毎日です。 その結果、オープンソースソフトウェアの海から自分のプロジェクトを目立たせることはますます困難になってきています。 ただし、他の開発者の注意を引く可能性を高めるために、いくつかのことを行うことができます。 一つの効果的かつシンプルな技術は、見栄えの良い、役に立つREADMEファイルを置くことです。
あなたのREADMEはあなたのプロジェクトと同じくらい良いはずです。, 大READMEファイルをプロジェクトの海のオープンソースソフトウェアをGitHub.
READMEはあなたのプロジェクトの顔のようなものです。 これは、ソースツリーに遭遇したときに人が読むべき最初のファイルであり、ソフトウェアの非常に簡単で基本的な紹介として書かれるべきです。
READMEなしのプロジェクトはあまり役に立ちません。 例えば、このプロジェクトを見てみましょう。
READMEなし、説明なし、何もありません。 この男が何を作ったのか分からないどんなに素晴らしいものであっても,
さて、このプロジェクトを見てみましょう。 著者は、プロジェクトについての詳細かつ明確な指示を述べているので、他の人が使用して試してみるのが簡単です。
素敵なREADMEは、人々がプロジェクトにも従事するのを助ける良い方法です。 素敵なREADMEとスクリーンショットを持つプロジェクトは、なぜこのプロジェクトが重要なのか、なぜ人々がプロジェクトを使用して貢献する必要があるの 良いREADMEには、新しいユーザーが始めるのに役立つ十分な詳細も含める必要があります。, コンパイルする方法、インストールする方法、統合を開始する方法。
Ok。 十分な話。 その後、良いREADMEを書く方法を教えてください。
READMEが重要であることに同意したので、私はそれを書く方法を教えてあげましょう。 それほど難しいことではない。 あなたはいくつかの箇条書きに固執する必要があります。 READMEを書くときに覚えておくべきポイントのいくつかは次のとおりです。
READMEのフォーマット？,
READMEに書く方法と書き方を教えてくれたので、README別名formattingのスタイリングについて少し話しましょう。
書式設定はREADMEの重要な部分です。 READMEのフォーマット方法については、hereとhereから学ぶことができます。
最後に、心に留めておいてください—
あなたはフルボアReadme駆動開発を行く必要はありません、あなたはすべての箇条書きを含める必要はありません、あなたは特定のプロセスに従う必要はありません。 ものを書くのはREADME違文書のスキルはあなたをより善い。,
Leave a Reply