[[435194]]

Hacktober 已經(jīng)結(jié)束了，但這并不意味鼓勵(lì)程序員為開(kāi)源做貢獻(xiàn)的結(jié)束。維護(hù)者吸引更多長(zhǎng)期貢獻(xiàn)者的方法之一是寫一個(gè)規(guī)范的 README。這里，參照一些流行的開(kāi)源庫(kù)中的 README 整理了一份清單，讓你創(chuàng)建一個(gè)能吸引貢獻(xiàn)者加入你的社區(qū)的 README。

Hacktoberfest 是由知名云服務(wù)商 DigitalOcean 發(fā)起的一個(gè)推廣、支持開(kāi)源的年度在線活動(dòng)，任何一個(gè)開(kāi)源愛(ài)好者都可以參與。只要在10月份內(nèi)向 GitHub 上的任意開(kāi)源項(xiàng)目提交若干 Pull Request，就算完成活動(dòng)任務(wù)，并將得到由 DigitalOcean、GitHub 等活動(dòng)贊助商提供的紀(jì)念品。通常是限量版T恤、貼紙若干。

那么，Hacktoberfest 這個(gè)奇怪的名字是什么意思呢?這不是一個(gè)原生的英文單詞，是由幾個(gè)代表著這個(gè)活動(dòng)的核心精神的單詞縮寫組合而成。其中的 Hacktober 是由 Hackathon(黑客馬拉松) 和 October(十月) fest 則是 Festival(節(jié)日)的前幾個(gè)字幕。看到這里，大家應(yīng)該就明白了吧， Hacktoberfest 就是開(kāi)源愛(ài)好者在每年的十月份通過(guò)做開(kāi)源貢獻(xiàn)的方式來(lái)傳播、慶祝開(kāi)源。

我為什么要寫 README?

就像找工作要寫個(gè)人簡(jiǎn)歷一樣，為自己的開(kāi)源項(xiàng)目寫一個(gè)優(yōu)秀的 README 同樣重要。你README 可以為新用戶和潛在貢獻(xiàn)者提供了對(duì)我們項(xiàng)目的第一印象。說(shuō)白了，你的 Contributing.md 可以讓貢獻(xiàn)者在你的版本庫(kù)中提出和合并拉動(dòng)請(qǐng)求，而你的 README 則指導(dǎo)用戶如何使用你的項(xiàng)目。

我應(yīng)該在 README 中寫些什么?

首先添加項(xiàng)目標(biāo)題

這個(gè)例子來(lái)自 Open sauce。

添加一些簡(jiǎn)短的陳述，描述項(xiàng)目出現(xiàn)原因和作用

這個(gè)例子來(lái)自Slinkity

告知用戶如何安裝和使用我們的項(xiàng)目

這個(gè)例子來(lái)自Timber

讓用戶知道如何獲得幫助

這個(gè)例子來(lái)自RasaHQ

包括重要文檔的鏈接

這個(gè)例子來(lái)自CodeNameOne

展示你的貢獻(xiàn)者

這個(gè)例子來(lái)自 use-shopping-cart

添加項(xiàng)目的許可證

這個(gè)例子來(lái)自 use-shopping-cart

可以附加一點(diǎn)

• 目錄(這里有一個(gè)關(guān)于自動(dòng)生成目錄的文檔)
• 項(xiàng)目的技術(shù)堆棧和功能
• 已經(jīng)在用的產(chǎn)品
• 項(xiàng)目的用戶界面截圖
• 依賴
• 已知的問(wèn)題

怎么把它弄漂亮點(diǎn)

試試使用Readme.so，這是由Katherine Peterson建立的開(kāi)源項(xiàng)目，可以輕松建立和定制README的所有部分。

作者：Rizel Scarlett 譯者：前端小智 來(lái)源：dev 原文：https://dev.to/github/how-to-create-the-perfecreadme-for-your-open-source-project-1k69