日韩无码专区无码一级三级片|91人人爱网站中日韩无码电影|厨房大战丰满熟妇|AV高清无码在线免费观看|另类AV日韩少妇熟女|中文日本大黄一级黄色片|色情在线视频免费|亚洲成人特黄a片|黄片wwwav色图欧美|欧亚乱色一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時(shí)間：8:30-17:00
你可能遇到了下面的問題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
把一個(gè)庫開源，你該做些什么

把一個(gè)庫[1]開源非常簡單，僅需幾秒鐘。你所需要做的僅僅是把公共倉庫(public repository) 托管 (hosted) 在網(wǎng)上(GitHub, Bitbucket,等等)嗎？不！事實(shí)上，如果你對非?？岬牟⑶铱梢怨_使用的庫悉心照料的話[2]，這樣做對每個(gè)人都是件更好的事情。來看下這些是怎么做到的。

10年積累的網(wǎng)站建設(shè)、做網(wǎng)站經(jīng)驗(yàn)，可以快速應(yīng)對客戶對網(wǎng)站的新想法和需求。提供各種問題對應(yīng)的解決方案。讓選擇我們的客戶得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識你，你也不認(rèn)識我。但先網(wǎng)站設(shè)計(jì)后付款的網(wǎng)站建設(shè)流程，更有永平免費(fèi)網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。

README的編寫

README文件在你的項(xiàng)目中占據(jù)首要地位。你的項(xiàng)目必須包含它！這個(gè)文件必須包含庫的名字和一個(gè)關(guān)于它(簡短的)描述。把描述這一章節(jié)當(dāng)作是電梯游說 (elevator pitch，在乘電梯的30秒內(nèi)清晰準(zhǔn)確地向客戶解釋清楚解決方案)。

然后是編寫使用章節(jié)。盡可能詳細(xì)地用文字、代碼片段、截圖或者GIF格式的圖片，來描述如何使用你的庫。這個(gè)就是你項(xiàng)目的文檔, 你的庫很多時(shí)候也同樣如此, 這將會是你唯一提供的文檔。

先寫使用指南這部分并不是一個(gè)隨意的選擇。README文件應(yīng)該能吸引讀者(blow your reader's mind)，這樣他們就會使用你的庫并為它做出貢獻(xiàn)(或許不會)。

第三小節(jié)必須寫安裝方法。這個(gè)小節(jié)以*用戶*的角度說明怎樣快速安裝你的庫。如果有多種安裝方式，首先介紹你認(rèn)為最好的方式，然后才是(介紹)其他的。

你可以添加一個(gè)依賴章節(jié)，例如，依賴X的Y版本(Depends on X version Y) 。這個(gè)章節(jié)是可選的，可以不寫。

第四個(gè)必須編寫的小節(jié)是貢獻(xiàn)。盡管它可以使用一個(gè)CONTRIBUTING 文件代替。說明怎樣折騰你的庫(how to hack your library)，怎樣報(bào)告bugs，或者怎樣提交特性請求(submit feature requests)。這方面介紹一定要詳細(xì)。說明規(guī)則，讓收到的請求合并中避免評論每一行[3]，指引貢獻(xiàn)者使用恰當(dāng)?shù)墓ぞ?Point contributors to the right tools )，比如linters 或者 compilers。

你還必須添加一個(gè)測試章節(jié)。說明怎樣安裝測試套件，怎樣運(yùn)行功能測試(functional tests)，以及需要安裝的工具。

如果你使用第三方的東西，或者打算列出貢獻(xiàn)者(當(dāng)然這個(gè)也可以寫在作者章節(jié))，那就添加一個(gè)信用(Credits)章節(jié)。這個(gè)章節(jié)是可選的，可以不寫。

最后還要記住，添加一個(gè)許可證章節(jié)!

模板如下(Markdown 語法)：

 
 
 
    
  
  
  
  1. project-x     <-------- 一級標(biāo)題 (項(xiàng)目名字) 
    2. 
  
  
  
  2. ========= 
    3. 
  
  
  
  3. 
  
  
  
  4. project-x is a better way to achieve this and that, by leveraging the new API, 
    5. 
  
  
  
  5. blablabla. 
    6. 
  
  
  
  6. project-x用更好的方式實(shí)現(xiàn)某某功能，通過使用高效的新API，此處省略N個(gè)字。 
    7. 
  
  
  
  7. 
  
  
  
  8. ## Usage(使用)     <-------- 二級標(biāo)題 
    9. 
  
  
  
  9. ... 
    10. 
  
  
  
  10. 
  
  
  
  11. ## Installation(安裝) 
    12. 
  
  
  
  12. ... 
    13. 
  
  
  
  13. 
  
  
  
  14. ## Requirements(依賴) 
    15. 
  
  
  
  15. ... 
    16. 
  
  
  
  16. 
  
  
  
  17. ## Contributing(貢獻(xiàn)) 
    18. 
  
  
  
  18. 
  
  
  
  19. See CONTRIBUTING file. 
    20. 
  
  
  
  20. 查看 CONTRIBUTING 文件。 
    21. 
  
  
  
  21. 
  
  
  
  22. ## Running the Tests(執(zhí)行測試) 
    23. 
  
  
  
  23. ... 
    24. 
  
  
  
  24. 
  
  
  
  25. ## Credits(信用) 
    26. 
  
  
  
  26. ... 
    27. 
  
  
  
  27. 
  
  
  
  28. ## License(許可證) 
    29. 
  
  
  
  29. 
  
  
  
  30. project-x is released under the MIT License. See the bundled LICENSE file for  
    31. 
  
  
  
  31. details. 
    32. 
  
  
  
  32. project-x 依據(jù) MIT許可證發(fā)布。詳細(xì)請看捆綁的 LICENSE 文件。
    33.

正如你所看到的, 我在模板里介紹了兩個(gè)文件: LICENSE(許可證)和CONTRIBUTING(貢獻(xiàn)指南)。貢獻(xiàn)這一小節(jié)的內(nèi)容用一個(gè)文件CONTRIBUTING代替了。LICENSE(許可證)這個(gè)文件里包含了你項(xiàng)目選擇的許可證，但你應(yīng)該選用哪個(gè)許可證呢？

許可證

我不想把所有的許可證都一一對比，你可以訪問tl;drLegal這個(gè)網(wǎng)站，它用易懂的話(simple words)向你介紹實(shí)用的(useful)開源許可證相關(guān)信息。

我傾向于使用 MIT許可證，因?yàn)樗浅Ｗ杂?liberal)。我這里的建議是參考下你的社區(qū)，選擇最恰當(dāng)?shù)囊粋€(gè)。比如說，在Symfony2 (一個(gè)PHP框架)社區(qū)，大多數(shù)相關(guān)的項(xiàng)目或者bundles 都是以MIT許可證發(fā)布的。而Java 的項(xiàng)目經(jīng)常以Apache許可證2.0(Apache License 2.0)發(fā)布的。

根據(jù)最近的報(bào)道(reports)，大多數(shù) GitHub上的項(xiàng)目沒有一個(gè)開源許可證。這是不好的(bad)！你必須得有許可證，即使是啤酒軟件許可證(Beerware license)。

正如Hacker News所提到的，精心(carefully)選擇你的許可證。并且，不要用你自己做的許可證或者僅僅聲明這個(gè)項(xiàng)目屬于公共領(lǐng)域 (Public domain，簡單來說作品已屬于全人類)。公共領(lǐng)域在國際上的確不是準(zhǔn)確定義的概念，意味著不同國家會有不同的理解。

即使你現(xiàn)在有一個(gè)文檔完善的庫和一個(gè)許可證，還是沒有“征服世界”(dominate the world)[4]。下面，我給出一個(gè)概覽，介紹在開源項(xiàng)目中我認(rèn)為重要的東西。

寫自動化測試(Write Tests & Automate)

我們可以通過開源項(xiàng)目寫優(yōu)美的代碼，因?yàn)檫@里沒有截止期限，也沒有“客戶”。記住，你項(xiàng)目展示了你能夠做什么。作為一個(gè)開發(fā)者，你的庫就是你的名片。

寫大量的測試！如果沒有提供一個(gè)測試套件，怎么去期望別人能為你的庫做出貢獻(xiàn)呢？因此, 寫測試, 和使用 Travis CI。 添加一個(gè) .travis.yml 文件，描述怎么樣運(yùn)行你的測試。這也是另一種方式寫如何運(yùn)行測試的文檔。

在你的README文件里也添加一個(gè)狀態(tài)圖片(status image)。

留意一下(Take a look at)在線工具，例如PHP和JavaScript使用Scrutinizer , 或者 Puppet Linter。盡量使其自動化。

#p#

標(biāo)準(zhǔn)化(Be Standard)

在你的庫中使用恰當(dāng)?shù)墓ぞ?right tools)是非常重要的。再看一下你的社區(qū)，然后選擇大家常用(tend to use)的工具。在用PHP寫的程序里，大家都用 Composer 作為管理依賴關(guān)系的工具(dependency manager)。不要浪費(fèi)時(shí)間去用PEAR或者其他工具，就用Composer。如果是一個(gè)Node.js庫，在npm上注冊它。Ruby 的開發(fā)者，請把你的庫作為gem發(fā)布(distribute your library as a gem)。C#的開發(fā)者，請使用NuGet。

另一個(gè)例子，在Symfony2里，在Resources/doc 里添加文檔是一個(gè)好的做法(good practice)。這是個(gè)慣例。不要重復(fù)出現(xiàn)你的文檔，而是在你的README文件里添加一個(gè)快速跳到文檔的鏈接。

管理問題(Issues)和版本發(fā)布(Releases)

GitHub，CodePlex，或者其他你喜歡的，他們都提供了追蹤問題(issue tracker)的工具，請使用它！

如果你使用GitHub，不要浪費(fèi)時(shí)間在Wiki上。我從來沒有發(fā)現(xiàn)一個(gè)適當(dāng)?shù)墓ぷ髁鞒?decent workflow)。用README文件作為你的文檔，或者萬一(in case)文檔量很大(extensive documentation)的時(shí)候使用Read The Docs來做托管。使用 GitHub Issues 來管理里程碑，并用標(biāo)簽對問題進(jìn)行分類。

還有，嘗試盡快回復(fù)所有的問題…但be careful, and manage your time。對人友好，花時(shí)間幫助新來的人。非常值得去學(xué)習(xí)如何維護(hù)一個(gè)成功的開源項(xiàng)目。

另一個(gè)建議是，定期地打上版本標(biāo)簽來進(jìn)行發(fā)布(to release often by tagging versions periodically)。談起版本, 請關(guān)注(follow) Semantic Versioning Specification。

然后，用CHANGELOG(更改日志)這個(gè)文件來幫助用戶識別出你做出的更改。如果你不向后兼容，寫一個(gè)UPGRADE(升級)文件介紹說明如何升級。

你需要反饋！

我開源大量項(xiàng)目最主要的原因是，可以從用戶的反饋中學(xué)到很多東西。所以你需要反饋，我需要反饋，每個(gè)人都需要反饋！在Twitter，Hacker News等等上分享你的項(xiàng)目。讓全世界都知道！人們必須知道你的項(xiàng)目并不是因?yàn)樗艹錾?，令人難忘，而是因?yàn)槿藗兛梢栽u論它。

使用 GitHub pages 為你的項(xiàng)目創(chuàng)建主頁，如果你愿意還可以買個(gè)域名，

還記得"征服世界"的計(jì)劃嗎？你要實(shí)現(xiàn)這個(gè)目標(biāo)幾乎需要到的，我們永遠(yuǎn)不知道。

雇人(Hire People)

一旦你"征服世界"，招收別人(enroll new people)[5]來幫助你非常重要這是非常棒的體驗(yàn)。這樣會給你更多的時(shí)間來搞其他開源項(xiàng)目(也可以說是征服另一個(gè)世界的計(jì)劃) ????

總而言之

讓一個(gè)庫開源不僅僅是發(fā)布源代碼。你還需要再做一些事情來讓別人更容易更愉快地使用它。為項(xiàng)目寫文檔展示了你的教學(xué)能力，這樣就可以找到恰當(dāng)?shù)脑~來表達(dá)你的想法。當(dāng)然，還說明了你在用心地做這件事。

不要忘記在你的庫里面添加測試，如果你在工作中不方便，回家再做。還有別忘了許可證，別找借口！

開源項(xiàng)目真的非?？幔且苊夥俏野l(fā)明癥(Not Invented Here (NIH) Syndrome)。盡可能地做貢獻(xiàn)，而不是再開創(chuàng)一個(gè)已有的開源項(xiàng)目，重復(fù)造輪子。

TL;DR

你的庫或者項(xiàng)目：

  • 必須有一個(gè)README文件，內(nèi)容包括名字，描述還有以下章節(jié)：使用方法，安裝指南，貢獻(xiàn)規(guī)范，如何測試和許可證；
  • 必須有一個(gè)顯眼的許可證(MUST have a license that is visible)；
  • 必須能測試(MUST be tested);
  • 必須標(biāo)準(zhǔn)化或者符合你社區(qū)的慣例；

你：

  • 需要反饋；
  • 必須待人友善；
  • 應(yīng)該招人(enroll people)。

順便說一下：如果你發(fā)現(xiàn)排版錯(cuò)誤和錯(cuò)別字。請派生(fork)和修改它。非常感謝！本文以Creative Commons Attribution-ShareAlike 3.0 Unported License許可證發(fā)表。

譯注：

  1. I use “project” as a synonym of “l(fā)ibrary”,My blog post focuses on libraries as Open Source projects, rather than “projects” like products (applications). 原作者的開源項(xiàng)目主要是庫，所以這篇文章對其他類型的開源項(xiàng)目同樣適用。

  2. 原文：add some love to your new shiny library you just made publicly available.

    • love = take care of
    • shiny = well, shiny is… shiny, something which is cool, and beautiful

  3. 原文：Explain the rules to avoid commenting every single line in Pull Requests you receive.

  4. it's a joke, 這是個(gè)玩笑。

  5. 作者原話：enroll = hire (more or less), but it's not because of the previous sentence. You don't hire people “for real” (like a company would do I mean) 因此我把 enroll 譯作 招收

原文地址: On Open Sourcing Libraries

譯文鏈接：http://funwo.tk/2013-08-06-on-open-sourcing-libraries-cn.html


本文題目：把一個(gè)庫開源，你該做些什么
當(dāng)前路徑：http://m.5511xx.com/article/cdpdgjc.html