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

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

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
82天突破1000star，項目團隊梳理出軟件開源必須注意的8個方面

近期，我們在GitHub上開源了微服務(wù)任務(wù)調(diào)度框架SIA-TASK，82天，收獲了1000+個star！由于這是SIA團隊第一次開源項目，開源的相關(guān)工作，團隊之前并沒有太多的經(jīng)驗，因此我們特別整理了本次開源的各種記錄事項，希望給今后開源的項目做參考。

創(chuàng)新互聯(lián)專注為客戶提供全方位的互聯(lián)網(wǎng)綜合服務(wù)，包含不限于做網(wǎng)站、成都網(wǎng)站制作、海鹽網(wǎng)絡(luò)推廣、重慶小程序開發(fā)公司、海鹽網(wǎng)絡(luò)營銷、海鹽企業(yè)策劃、海鹽品牌公關(guān)、搜索引擎seo、人物專訪、企業(yè)宣傳片、企業(yè)代運營等，從售前售中售后，我們都將竭誠為您服務(wù)，您的肯定，是我們最大的嘉獎；創(chuàng)新互聯(lián)為所有大學生創(chuàng)業(yè)者提供海鹽建站搭建服務(wù)，24小時服務(wù)熱線：18982081108，官方網(wǎng)址：www.cdcxhl.com

一、開發(fā)

在開源項目的開發(fā)過程中要注意以下幾點：

  • 首先，要給自己的項目取一個合適的名字，取名規(guī)則這里不再贅述，需要強調(diào)的一點是：項目名稱不能與GitHub上已開源過的項目名稱相同。
  • 其次，選擇合適的編程語言。
  • 再次，編碼過程中要注意代碼的規(guī)范。

最后要說的就是開源協(xié)議的選擇了，目前最流行的開源協(xié)議有以下六種：GPL、BSD、MIT、Mozilla、Apache和LGPL。

不同的開源協(xié)議之間的差別還是挺大的，具體如何選擇，可以參考一張圖看懂開源協(xié)議（https://blog.csdn.net/cwt19902010/article/details/53736746），如果這些常用的開源協(xié)議都不適合你的項目，你也可以自己寫一個自己的開源協(xié)議。

為了更方便查看開源協(xié)議選擇圖，參考圖如下：

以Apache License Version 2.0協(xié)議為例,比較常用協(xié)議與Apache協(xié)議沖突情況，沖突圖如下：

二、協(xié)議

項目開發(fā)完成之后，需要梳理出項目中使用到的協(xié)議（包含項目引用的組件中用到的協(xié)議），此處推薦使用maven許可證插件。插件配置參見License Maven Plugin（https://www.mojohaus.org/license-maven-plugin/），maven許可證插件在主pom中配置示例如下（此處開源協(xié)議采用Apache 2.0）

 
 
 
    
  
  
  
  1.  
    2. 
  
  
  
  2.      
    3. 
  
  
  
  3.          
    4. 
  
  
  
  4.             Apache License, Version 2.0 
    5. 
  
  
  
  5.             http://www.apache.org/licenses/LICENSE-2.0.html 
    6. 
  
  
  
  6.             repo 
    7. 
  
  
  
  7.          
    8. 
  
  
  
  8.      
    9. 
  
  
  
  9.  
    10. 
  
  
  
  10.      
    11. 
  
  
  
  11.           
    12. 
  
  
  
  12.              org.codehaus.mojo 
    13. 
  
  
  
  13.              license-maven-plugin 
    14. 
  
  
  
  14.              1.13 
    15. 
  
  
  
  15.               
    16. 
  
  
  
  16.                   
    17. 
  
  
  
  17.                  ${main.basedir} 
    18. 
  
  
  
  18.                  LICENSE-3RD-PARTY 
    19. 
  
  
  
  19.                  /org/codehaus/mojo/license/third-party-file-groupByLicense.ftl 
    20. 
  
  
  
  20.                  true 
    21. 
  
  
  
  21.                  ${main.basedir}/LICENSE-3RD-PARTY.properties 
    22. 
  
  
  
  22.                  ${main.basedir}/LICENSE-3RD-PARTY.properties 
    23. 
  
  
  
  23.                   
    24. 
  
  
  
  24.                      Apache 2.0|ASL, version 2|http://www.apache.org/licenses/LICENSE-2.0.txt|http://asm.ow2.org/license.html|The Apache License, Version 2.0|Apache License|Apache License Version 2|Apache License Version 2.0|Apache Software License - Version 2.0|Apache 2.0 License|Apache License 2.0|ASL|Apache 2|Apache-2.0|the Apache License, ASL Version 2.0|The Apache Software License, Version 2.0|Apache License, Version 2.0|Apache Public License 2.0 
    25. 
  
  
  
  25.                      BSD|The BSD 3-Clause License|The BSD License|Modified BSD License|New BSD License|New BSD license|Two-clause BSD-style license|BSD licence|BSD New|The New BSD License|BSD 3-Clause|BSD 3-clause 
    26. 
  
  
  
  26.                      MIT|MIT License|The MIT License 
    27. 
  
  
  
  27.                      LGPL|LGPL, version 2.1|GNU Library or Lesser General Public License (LGPL) V2.1|GNU Lesser General Public License (LGPL), Version 2.1|GNU Lesser General Public License, Version 2.1|LGPL 2.1 
    28. 
  
  
  
  28.                      CDDL|CDDL+GPL|CDDL+GPL License|CDDL + GPLv2 with classpath exception|CDDL License|CDDL 1.0|CDDL 1.1|COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0|Common Development and Distribution License (CDDL) v1.0 
    29. 
  
  
  
  29.                      EPL|Eclipse Public License - Version 1.0 
    30. 
  
  
  
  30.                      GPL|GPL2 w/ CPE|GPLv2+CE|GNU General Public Library 
    31. 
  
  
  
  31.                      MPL|MPL 1.1 
    32. 
  
  
  
  32.                      Public Domain 
    33. 
  
  
  
  33.                      Common Public License|Common Public License Version 1.0 
    34. 
  
  
  
  34.                      CC0|CC0 1.0 Universal|Public Domain, per Creative Commons CC0 
    35. 
  
  
  
  35.                      Unknown License|Unknown license 
    36. 
  
  
  
  36.                   
    37. 
  
  
  
  37.  
    38. 
  
  
  
  38.                   
    39. 
  
  
  
  39.                  true 
    40. 
  
  
  
  40.                   
    41. 
  
  
  
  41.                  ${main.basedir}/lic/licenses.xml 
    42. 
  
  
  
  42.                  ${main.basedir}/lic/licenses/ 
    43. 
  
  
  
  43.  
    44. 
  
  
  
  44.                   
    45. 
  
  
  
  45.                  apache_v2 
    46. 
  
  
  
  46.                  2019 
    47. 
  
  
  
  47.                  sia 
    48. 
  
  
  
  48.                  task 
    49. 
  
  
  
  49.                   
    50. 
  
  
  
  50.                      src/main/java 
    51. 
  
  
  
  51.                      src/test/java 
    52. 
  
  
  
  52.                   
    53. 
  
  
  
  53.                   
    54. 
  
  
  
  54.                      **/*.java 
    55. 
  
  
  
  55.                      **/*.xml 
    56. 
  
  
  
  56.                      **/*.sh 
    57. 
  
  
  
  57.                      **/*.py 
    58. 
  
  
  
  58.                      **/*.properties 
    59. 
  
  
  
  59.                      **/*.sql 
    60. 
  
  
  
  60.                      **/*.html 
    61. 
  
  
  
  61.                      **/*.less 
    62. 
  
  
  
  62.                      **/*.css 
    63. 
  
  
  
  63.                      **/*.js 
    64. 
  
  
  
  64.                      **/*.json 
    65. 
  
  
  
  65.                   
    66. 
  
  
  
  66.                  true 
    67. 
  
  
  
  67.                  true 
    68. 
  
  
  
  68.                  false 
    69. 
  
  
  
  69.                  true 
    70. 
  
  
  
  70.                  << 
    71. 
  
  
  
  71.                  >> 
    72. 
  
  
  
  72.                  == 
    73. 
  
  
  
  73.  
    74. 
  
  
  
  74.                   
    75. 
  
  
  
  75.                  ${main.basedir}/LICENSE 
    76. 
  
  
  
  76.               
    77. 
  
  
  
  77.           
    78. 
  
  
  
  78.           
    79. 
  
  
  
  79.              org.jasig.maven 
    80. 
  
  
  
  80.              maven-notice-plugin 
    81. 
  
  
  
  81.              1.0.6.1 
    82. 
  
  
  
  82.               
    83. 
  
  
  
  83.                  false 
    84. 
  
  
  
  84.                  https://source.jasig.org/licenses/NOTICE.template 
    85. 
  
  
  
  85.                   
    86. 
  
  
  
  86.                      https://source.jasig.org/licenses/license-mappings.xml 
    87. 
  
  
  
  87.                   
    88. 
  
  
  
  88.               
    89. 
  
  
  
  89.           
    90. 
  
  
  
  90.       
    91.

配置完成之后，執(zhí)行如下命令即可生成相應的協(xié)議到對應的文件，命令如下：

 
 
 
    
  
  
  
  1. #### Updates (or creates) the main project license file according to the license defined in the licenseName parameter.
    2. 
  
  
  
  2. `mvn license:update-project-license`
    3. 
  
  
  
  3. 
  
  
  
  4. #### Generates a file containing a list of all dependencies and their licenses for a multi-module build.
    5. 
  
  
  
  5. `mvn license:aggregate-add-third-party`
    6. 
  
  
  
  6. 
  
  
  
  7. #### Downloads the license files associated with each dependency for a multi-modules build.
    8. 
  
  
  
  8. `mvn license:aggregate-download-licenses`
    9. 
  
  
  
  9. 
  
  
  
  10. #### Generate NOTICE?
    11. 
  
  
  
  11. `mvn notice:generate`
    12.

項目開源時，需要在源文件的頂部添加一個保護許可，修改、檢查、刪除源文件頭部保護許可命令如下：

 
 
 
    
  
  
  
  1. #### how to generate/update source code header?
    2. 
  
  
  
  2. ## Updates the license header of the current project source files.
    3. 
  
  
  
  3. mvn license:update-file-header
    4. 
  
  
  
  4. ## Checks the license header of the current project source files.
    5. 
  
  
  
  5. mvn license:check-file-header
    6. 
  
  
  
  6. ## Remove any license header of the current project source files.
    7. 
  
  
  
  7. mvn license:remove-file-header
    8.

執(zhí)行完上述命令之后，會生成幾個協(xié)議文件，其中有兩個關(guān)鍵的文件：

 
 
 
    
  
  
  
  1. LICENSE文件：存放當前開源項目中用到的開源協(xié)議信息。
    2. 
  
  
  
  2. LICENSE-3RD-PARTY文件：組件使用到的協(xié)議。
    3.

在LICENSE-3RD-PARTY文件中查看組件使用的協(xié)議，參考前面介紹的各協(xié)議沖突情況，查看看組件中用到的協(xié)議是否與當前開源項目選擇的開源協(xié)議有沖突，如果有沖突，需要替換掉協(xié)議沖突的接口。

三、安全掃描 

安全掃描是項目開源流程中必不可少的一步，安全掃描關(guān)注的點主要有以下幾個：

  • 組件層面安全問題。比如：組件是否存在遠程代碼執(zhí)行風險、XXE風險等。
  • 代碼層面安全問題。比如：RequestMapping上請求未限制方法等。
  • 公司敏感信息是否外泄。比如：數(shù)據(jù)庫連接信息、郵箱信息等被暴露。

備注：安全掃描工作由安全部·安全服務(wù)團隊的同事負責完成，項目開發(fā)完成之后，可聯(lián)系安全服務(wù)團隊的同事進行代碼安全掃描工作。四、文檔 

README文檔相當于開源項目的一個門面，如果README文檔寫得好，能夠讓用戶更了解開源項目的功能，減少用戶的使用成本?？梢哉fREADME文檔寫得好的開源項目不一定是好的開源項目，但是好的開源項目的README文檔寫得一定好。 下面簡單介紹下README文檔的編寫規(guī)范。綜合GitHub上很多大型開源項目的README文檔，個人認為READEME文檔主要由以下幾部分組成：1）項目介紹項目介紹是為了讓別人快速了解項目。主要內(nèi)容包括項目背景、項目簡介。2）項目架構(gòu)項目架構(gòu)主要介紹項目的實現(xiàn)方式，可以讓用戶更了解項目的實現(xiàn)原理。 3）項目集成方式 項目集成方式即項目開發(fā)指南，可以列出項目的部署方式，或者是jar包的使用方式。4）項目使用指南項目使用指南也就是告訴用戶怎么使用項目。最好是附上每一步的使用截圖信息，這樣能減少后期跟用戶之間的溝通成本。5）版本說明此處需要告訴用戶使用哪個版本更穩(wěn)定。6）版權(quán)說明版權(quán)信息可以用于作者的維權(quán)，保護作者版本信息的合法權(quán)益。7）項目交流方式項目交流方式部分可以留下開源作者或者是組織的微信、微博、郵箱等聯(lián)系方式，方便用戶與開源作者進一步技術(shù)溝通。 五、版本 

GitHub上開源的項目需要有個版本號，版本格式為：
主版本號.次版本號.修訂號，版本號遞增規(guī)則如下：

  • 主版本號：當你做了不兼容的 API 修改；
  • 次版本號：當你做了向下兼容的功能性新增；
  • 修訂號：當你做了向下兼容的問題修正。

 先行版本號及版本編譯元數(shù)據(jù)可以加到“主版本號.次版本號.修訂號”的后面，作為延伸。

更形象的解釋如下
：標準的版本號必須采用 X.Y.Z 的格式，其中 X、Y 和 Z 為非負的整數(shù)，且禁止在數(shù)字前方補零。X 是主版本號、Y 是次版本號、而 Z 為修訂號。每個元素必須以數(shù)值來遞增。例如：1.9.1 -> 1.10.0 -> 1.11.0。
備注：
開源版本規(guī)范引自
GitHub命名規(guī)范：語義化版本2.0.0
：
https://semver.org/lang/zh-CN/

六、開源

做完上述幾步的工作之后，我們就可以把項目上傳到GitHub上進行開源了。GitHub的使用網(wǎng)上有很多文章介紹，這里不再贅述，可以參考 在GitHub上參與開源項目日常流程：https://blog.csdn.net/five3/article/details/9307041

七、后期

開源后期維護服務(wù)是開源項目時最容易被忽視的，為了讓用戶更好地使用開源項目，我們可以通過GitHub issue、微信答疑群、論壇、社區(qū)文章分享等互動形式做好開源后期服務(wù)工作。

八、迭代

GitHub上迭代開發(fā)流程如下：項目owner給項目開發(fā)者設(shè)置member權(quán)限，member用戶fork開源項目的資源成自己的資源，然后修改fork之后的資源，修改完成之后，提merge請求，只有項目owner才有權(quán)限merge。如何同步fork項目可參見如下文章如何同步fork項目：https://blog.csdn.net/t111t/article/details/45894381

開源項目：
微服務(wù)任務(wù)調(diào)度框架 ：https://github.com/siaorg/sia-task

微服務(wù)路由網(wǎng)關(guān) ：https://github.com/siaorg/sia-gateway

【本文是專欄機構(gòu)宜信技術(shù)學院的原創(chuàng)文章，微信公眾號“宜信技術(shù)學院( id: CE_TECH)”】


本文題目：82天突破1000star，項目團隊梳理出軟件開源必須注意的8個方面
文章分享：http://m.5511xx.com/article/dhceehp.html