[讨论] 一个正式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