[討論] 一個正式open source該有的內容

作者: MacOSX11 (MacOSX11)   2019-07-17 20:38:50
大家好
小弟在資訊業服務但是待的部門偏研究新技術並藉由外部廠商設備驗證
因為未來有想要往外跳的打算
因此下班有打算多寫幾個有點小規模的開源side project
也打算邊做邊學一些實作的最新技術以及補一下以前沒學好的底層軟硬體知識QQ 同時看能不能賺點星星?
半年來目前寫了第一份
第二份已經想好要學的東西 但是還沒想好要寫的應用目標
想問的是
目前看了一些有名開源專案
似乎就是提供makefile、readme就已經很完整了?
還是說有給測試工具跟設定的話會比較容易賺星星呢
或是說應該還要加些什麼以後投履歷的時候比較好看呢
https://github.com/w180112/PPPoE_Client_DPDK
感謝大家
作者: LinuxKernel (Linus Torvalds)   2019-07-17 20:49:00
README是門面,重點還是回歸東西本身。
作者: sharku (明珠求瑕)   2019-07-17 20:59:00
有需求而且好用較容易賺星星
作者: longlongint (華哥爾)   2019-07-17 21:02:00
LICENSE
作者: howardgj94 (飄飄渺渺所為誰)   2019-07-17 21:02:00
就好用或對開發有幫助就會給星吧。你做這個感覺demo性質不太好賺星﹖題外話,用人稱要注意,中文說我們很口語,但是英文用our他們會覺得誰跟你我們
作者: Hevak (Arthow Eshes)   2019-07-17 21:13:00
星星跟好不好用和有沒有宣傳息息相關,星星少不會難看
作者: vi000246 (Vi)   2019-07-17 21:37:00
你可以學學中國人 整理一些資料星星數就好幾千了或是幫忙把文章翻成中文
作者: j0958322080 (Tidus)   2019-07-17 21:53:00
是說某碼猴多數OPENCV內容好像也是翻譯官網的??
作者: dces4212 (flawless)   2019-07-18 02:55:00
還有盜版pdf拿一堆星星的國人
作者: JustinHere (良葛格)   2019-07-18 07:33:00
提供清楚的文件
作者: sxy67230 (charlesgg)   2019-07-18 10:24:00
文件最好清楚,如果是java能提供pom範例跟資源,或是jar掛載方式,還有使用範例。Python 的話,最好寫清楚安裝方式,setup.py,requirement.txt檔,最好註明使用的lib的版本號。其他像是c這種也是註明自己是用哪一版的complier,有用哪些額外套件,需要設定哪些系統安裝方式都寫清楚。
作者: backprog (back-propagation)   2019-07-19 08:02:00
推,這件事比較少有人討論,但蠻重要的
作者: sxy67230 (charlesgg)   2019-07-19 09:08:00
我個人是覺得整理翻譯沒什麼不好的,畢竟很多新手剛入門的時候確實需要一份Roadmap可以節省找資源的力氣。像我念碩,大學沒唸過圖論,剛好研究領域需要碰到,教授也是第一次接觸這項新技術,那個時候剛好有中國教授整理的技術書,幫忙把圖論到該技術的拼圖都拼起來,確實省了很多閱讀研究的時間。
作者: kqalea (沙丁魚罐頭)   2019-07-19 13:50:00
只喵了一下,建議可以把deploy&testing加進去我個人會覺得至少一個開源的東西,code品質先不論應該有某種程度上可以"被測試"再來就是佈署的問題,建議用套件管理統一規劃不然基本上就是一個works on my platform project建議導入cmake或是其他build tool
作者: steve1012 (steve)   2019-07-20 03:46:00
這readme可以再改進一下....
作者: red0210 (My Name Is Red)   2019-07-20 15:12:00
看 ID 就知道是大大

Links booklink

Contact Us: admin [ a t ] ucptt.com