|
Hacktoberは終了しましたが、プログラマーにオープンソースへの貢献を奨励する活動が終わったわけではありません。メンテナーが長期的な貢献者を増やす方法の一つは、よく構成されたREADMEを作成することです。コミュニティに貢献者を引き付けるREADMEを作成するのに役立つ、いくつかの人気のあるオープンソースライブラリのREADMEを参考にまとめたリストを以下に示します。 Hacktoberfestは、著名なクラウドサービスプロバイダーであるDigitalOceanがオープンソースの促進と支援を目的として毎年開催しているオンラインイベントです。オープンソースに興味のある方なら誰でも参加できます。10月中にGitHub上のオープンソースプロジェクトに一定数のプルリクエストを送信するだけでイベントを完了し、DigitalOceanやGitHubなどのスポンサーから記念品を受け取ることができます。記念品は通常、限定版のTシャツやステッカーです。 では、Hacktoberfestという奇妙な名前は一体何を意味するのでしょうか？これは英語のネイティブな単語ではなく、このイベントの核となる精神を表す複数の単語の頭文字をとったものです。「Hacktober」は「Hackathon」と「October」に由来し、「fest」は「Festival」の最初の数文字です。これでお分かりいただけたでしょうか。Hacktoberfestとは、オープンソース愛好家が貢献を通じてオープンソースを広め、祝うために毎年10月に開催されるイベントです。 なぜ README を書いたのでしょうか?就職活動のための履歴書を書くのと同じように、オープンソースプロジェクトの優れたREADMEを書くことも同様に重要です。READMEは、新規ユーザーや潜在的なコントリビューターにプロジェクトの第一印象を与えます。簡単に言うと、Contributing.mdはコントリビューターがリポジトリにプルリクエストを送信したりマージしたりできるようにするためのものであり、READMEはユーザーにプロジェクトの使い方を案内するものです。 README には何を書けばいいですか?まず、プロジェクトのタイトルを追加します。 この例は Open source からのものです。 プロジェクトの理由と目的を説明する簡単な説明を追加します。 この例はSlinkityからのものです。 プロジェクトのインストール方法と使用方法をユーザーに通知する この例はTimberからのものです ユーザーにヘルプの受け方を知らせる この例はRasaHQからのものです。 重要な文書へのリンクが含まれています この例は CodeNameOne からのものです。 貢献者を表示する この例はuse-shopping-cartから引用したものです プロジェクトライセンスを追加する この例はuse-shopping-cartから引用したものです 少し追加することもできます
見た目をもっと美しくする方法 Katherine Peterson が作成したオープンソース プロジェクトである Readme.so を使用してみてください。これにより、README のすべての部分を簡単に構築およびカスタマイズできます。 著者: Rizel Scarlett 翻訳者: Front-end Xiaozhi 出典: dev 元記事: https://dev.to/github/how-to-create-the-perfecreadme-for-your-open-source-project-1k69 |
