開(kāi)源項(xiàng)目流程文檔化

對(duì)于一個(gè)項(xiàng)目的維護(hù)者來(lái)說(shuō)寫(xiě)文檔是最重要的事情之一。

文檔不僅說(shuō)清楚了你的想法是什么，而且還幫助別人在問(wèn)問(wèn)題之前理解你需要什么和接下在希望做什么。

將一些東西寫(xiě)下來(lái)，當(dāng)遇到不符合項(xiàng)目預(yù)期的內(nèi)容時(shí)，可以輕松的拒絕。同時(shí)，它對(duì)于人們的參與和提供幫助提供了指導(dǎo)。最有意思的是，撰寫(xiě)文檔的人可能永遠(yuǎn)也不知道是誰(shuí)讀了他寫(xiě)的文檔，或者使用項(xiàng)目。

即使你不想長(zhǎng)篇大論，對(duì)要點(diǎn)略說(shuō)一二也比啥都不寫(xiě)要好。

寫(xiě)下你的項(xiàng)目的發(fā)展方向

請(qǐng)?jiān)陧?xiàng)目啟動(dòng)時(shí)就寫(xiě)下項(xiàng)目目標(biāo)，并將之加到 README 文件中， 或者創(chuàng)建一個(gè)單獨(dú)的 VISION 文件，其它還能幫助人們了解這方面的信息如項(xiàng)目管理路線(xiàn)圖，最好是也把他們公開(kāi)。

有一個(gè)明確的，用文檔表達(dá)清晰的愿景，能保證項(xiàng)目的走向不會(huì)跑偏，同時(shí)也能保障因?yàn)槠渌呢暙I(xiàn)者增加的奇怪的需求而使項(xiàng)目變質(zhì)。

比如，@lord 發(fā)現(xiàn)項(xiàng)目有一個(gè)明確的愿景能夠幫助他決定哪個(gè) PR 值得花時(shí)間。作為一個(gè)維護(hù)者的新手，他甚至還后悔當(dāng)他接到第一個(gè)關(guān)于 slate ) PR 的時(shí)候沒(méi)有堅(jiān)持項(xiàng)目本身的原則。

我一直都在摸索。我沒(méi)有努力尋求一個(gè)完整的解決方案。與其采用那種半吊子辦法，我真希望曾經(jīng)對(duì)某些 Issue 的提出者說(shuō)：”我暫時(shí)沒(méi)有時(shí)間干這個(gè)，但是我會(huì)把他放到我的待辦事項(xiàng)中”。

— @lord , “開(kāi)源項(xiàng)目維護(hù)者新手的幾點(diǎn)技巧”

和大家交流你自己對(duì)項(xiàng)目的期望

制定規(guī)則是很傷腦筋的。有時(shí)候你可能覺(jué)得你像是在限制別人的行為或者說(shuō)把好玩的東西都搞沒(méi)了。

制定了規(guī)則，然后嚴(yán)格執(zhí)行，當(dāng)然啦，好的規(guī)則會(huì)讓維護(hù)者更輕松。他們會(huì)把你從做自己不愿意做的事情中解脫出來(lái)。

大多數(shù)知道你項(xiàng)目的人對(duì)你或者你的處境都是一無(wú)所知。他們可能會(huì)覺(jué)得你做這個(gè)項(xiàng)目是有錢(qián)拿的，特別是你的項(xiàng)目是他們經(jīng)常用的而且某種程度上有點(diǎn)依賴(lài)的時(shí)候。其實(shí)你只是在有時(shí)候會(huì)在項(xiàng)目上花很多時(shí)間，但是現(xiàn)在你在忙于新工作或者照顧剛出生的兒子。

這些都是再正常不過(guò)的事情！所以確保讓別人也知道這些。

如果你維護(hù)某個(gè)項(xiàng)目是利用空閑時(shí)間或者完全自愿的，能花多少時(shí)間就花多少時(shí)間。而不是你覺(jué)得項(xiàng)目需要你花多少時(shí)間或者別人想讓你花多少時(shí)間。

這里是一些值得你寫(xiě)進(jìn)項(xiàng)目里的東西：

• 怎樣的貢獻(xiàn)才會(huì)被復(fù)查和接受（需要測(cè)試嗎？提 Issue 有模板嗎？）
• 你本人會(huì)接受什么類(lèi)型的貢獻(xiàn)？（你是不是只希望在某些部分的代碼上需要?jiǎng)e人的幫助？）
• 在合適的時(shí)候跟進(jìn)項(xiàng)目（比如說(shuō) 如果你在七天之內(nèi)沒(méi)有收到 maintainer 的回復(fù)，而且依舊沒(méi)有其它任何的響應(yīng)，那么就直接找 Ta。）
• 你會(huì)在這個(gè)項(xiàng)目上花多少時(shí)間（比如說(shuō) “我們每星期只會(huì)在這個(gè)項(xiàng)目上花5個(gè)小時(shí)“）

Jekyll 、CocoaPods 、以及 Homebrew 均是為維護(hù)者和貢獻(xiàn)者提供了很好的基本規(guī)則的項(xiàng)目，乃業(yè)內(nèi)典范。

保證交流是公開(kāi)進(jìn)行的

不管是什么時(shí)候，保證你的交流是在公共的場(chǎng)所（就是大家都能看到的地方）。如果有人嘗試和你私聊，哪怕是討論一個(gè)新的需求或者功能，請(qǐng)禮貌的引導(dǎo) Ta 到公共的交流場(chǎng)所，比如郵件列表或者 issue tracker。

如果你和別的維護(hù)者見(jiàn)面了，或者在私下做了一個(gè)很重要的決定，把這些信息告訴大家，即使只是把你的筆記發(fā)上去。

這樣的話(huà)，每個(gè)人新加入到你們社區(qū)的人和已經(jīng)呆了多年的人能夠了解到的信息是一樣的。