如何為我的開源項目創建規范的 Readme？
Hacktober 已經結束了，但這并不意味鼓勵程序員為開源做貢獻的結束。維護者吸引更多長期貢獻者的方法之一是寫一個規范的 README。這里，參照一些流行的開源庫中的 README 整理了一份清單，讓你創建一個能吸引貢獻者加入你的社區的 README。
Hacktoberfest 是由知名云服務商 DigitalOcean 發起的一個推廣、支持開源的年度在線活動，任何一個開源愛好者都可以參與。只要在10月份內向 GitHub 上的任意開源項目提交若干 Pull Request，就算完成活動任務，并將得到由 DigitalOcean、GitHub 等活動贊助商提供的紀念品。通常是限量版T恤、貼紙若干。
那么，Hacktoberfest 這個奇怪的名字是什么意思呢?這不是一個原生的英文單詞，是由幾個代表著這個活動的核心精神的單詞縮寫組合而成。其中的 Hacktober 是由 Hackathon(黑客馬拉松) 和 October(十月) fest 則是 Festival(節日)的前幾個字幕。看到這里，大家應該就明白了吧， Hacktoberfest 就是開源愛好者在每年的十月份通過做開源貢獻的方式來傳播、慶祝開源。
我為什么要寫 README?
就像找工作要寫個人簡歷一樣，為自己的開源項目寫一個優秀的 README 同樣重要。你README 可以為新用戶和潛在貢獻者提供了對我們項目的第一印象。說白了，你的 Contributing.md 可以讓貢獻者在你的版本庫中提出和合并拉動請求，而你的 README 則指導用戶如何使用你的項目。
我應該在 README 中寫些什么?
首先添加項目標題
這個例子來自 Open sauce。
添加一些簡短的陳述，描述項目出現原因和作用
這個例子來自Slinkity
告知用戶如何安裝和使用我們的項目
這個例子來自Timber
讓用戶知道如何獲得幫助
這個例子來自RasaHQ
包括重要文檔的鏈接
這個例子來自CodeNameOne
展示你的貢獻者
這個例子來自 use-shopping-cart
添加項目的許可證
這個例子來自 use-shopping-cart
可以附加一點
- 目錄(這里有一個關于自動生成目錄的文檔)
- 項目的技術堆棧和功能
- 已經在用的產品
- 項目的用戶界面截圖
- 依賴
- 已知的問題
怎么把它弄漂亮點
試試使用Readme.so，這是由Katherine Peterson建立的開源項目，可以輕松建立和定制README的所有部分。
作者：Rizel Scarlett 譯者：前端小智 來源：dev 原文：https://dev.to/github/how-to-create-the-perfecreadme-for-your-open-source-project-1k69
