開源項目開始準備

時間 2019-11-12

標籤開源項目開始準備简体版

原文原文鏈接

肯定是 `組織` 仍是`項目`

組織：Facebook是一個組織帳戶，下面有許多項目。帳號名稱爲組織帳號。官網名稱爲：facebook.github.io/react
項目：專門針對一個產品，這個帳號下面就一個主產品，其它產品都是它的產品等分支。帳號名稱使用項目名稱便可。官網名稱爲：rollup.github.io

註冊帳號

建立項目

安裝git

下載git安裝包直接安裝
打開Git Bash命令框html

設置用戶，用戶名和密碼都設置爲GitHub的
git config --global user.name "Your Name"
git config --global user.email "email@example.com"

win建立SSH KEY

查看是否有SSH key
cat ~/.ssh/id_rsa.pub
若是不存在則建立
ssh-keygen -t rsa -C "171250669@qq.com"
建立後查看
cat ~/.ssh/id_rsa.pub
複製到剪貼板
clip < ~/.ssh/id_rsa.pub

將GitHub項目克隆到本地

進入要放置的文件
git clone git@github.com:Firsmant/info-manage.git

提交代碼

進入本地項目目錄
添加文件：git add .
提交到本地：git commit -m "first update"
將本地代碼同步到服務器：git push origin master

搭建開發環境

版本說明

版本號分三級
0.x.x能夠認爲是非正式版本、測試版本
從1.x.x開始正式發佈版本
"version":"0.0.1"node

一級：重構版本
二級：重大功能改進
三級：小升級或者bug修復

規範項目一級目錄

src - 源碼
release- 發佈結果
test- 單元測試用例
doc- 文檔
example - 示例

初始化

進入項目目錄運行 npm init按提示完成，參考package.json文件填寫相應內容。注意版本號和license不能默認，入口js修改成src/index.jsreact
生成package.json文件
webpack

構建工具

使用 webpackgit

安裝npm i babel-core babel-loader babel-polyfill babel-preset-es2015 babel-preset-latest webpack webpack-cli --save-dev
後面再加上淘寶鏡像
--registry=https://registry.npm.taobao.orggithub
在項目更目錄下建立.babelrc文件，添加內容

{ 
    "presets": ["es2015", "latest"],
    "plugins": [] 
}

在項目根目錄下建立webpack.config.js文件，添加內容以下
將entry文件發佈到output

module.exports = { 
    entry: './src/index.js',
    output: { path: __dirname,
        filename: './release/bundle.js' 
            },
    module: { 
        rules: [{ 
            test: /\.js?$/,
             exclude: /(node_modules)/, 
             loader: 'babel-loader' 
            }] 
    }
}

修改package.json中的scripts，添加"release":"webpack"，說明使用的打包工具

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "release": "webpack"
  },

運行npm run release生成release內容
在example文件夾中新增test.html文件，添加內容

<!DOCTYPE html>
 <html>
  <head> 
    <meta charset="UTF-8"> 
    <title>example</title> 
  </head> 
  <body>
    <p>example</p>

    <script src="../release/bundle.js"></script>
   </body> 
</html>

修改package.json中的scripts增長"example":"http-server -p 8880"

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "release": "webpack",
    "example": "http-server -p 8880"
  },

安裝服務器建立工具，運行npm install http-sever -g
將服務跑起來，運行npm run example

瀏覽器訪問localhost:8880/example/test.html

完善README.md

產品簡介
產品安裝和下載
快速使用（詳細文檔能夠外鏈）
交流提問區
關於做者（放置博客連接和收款二維碼）

寫文檔 & 寫測試用例

測試用例須要用到其它工具web

寫文檔

經過md格式生成文檔，安裝工具，npm install gitbook-cli -g
根目錄下建立SUMMARY.md，內容以下：

# Summary

* [項目介紹](README.md)
* [使用文檔](doc/use/README.md)
    * [使用1](doc/use/use1.md)
    * [使用2](doc/use/use2.md)
* [二次開發](doc/dev/README.md)
    * [開發1](doc/dev/dev1.md)
    * [開發2](doc/dev/dev2.md)

執行npm install gitbook -g安裝工具
執行gitbook init 按照以上目錄在doc中建立文件

執行 gitbook build將md文件發佈爲html文件
在http://localhost:8880/_book/中查看

提交代碼

使用 es-lint規範編碼npm

提交代碼版本v0.0.1

建立tag並提交

git tag -a 'v0.0.1' -m 'first commit'
git push origin v0.0.1

能夠在https://github.com/Firsmant/info-manage/releases進行查看

提交到npm

可讓用戶經過npm進行安裝json

運行npm adduser註冊帳戶
npm login登陸用戶
項目根目錄下執行npm publish .發佈到npm

代碼升級

建立分支 git checkout -b dev，在分支中進行修改
在package.js中修改版本號,而後提交修改
git add .
git commit -m "0.0.2"
git push origin dev
進入master分支git checkout master
將dev合併到mastergit merge div
提交mastergit push origin master
建立tag並提交到遠程
提交到npm