5-提交代碼.

寫代碼
重新編譯
寫文檔和寫測試用例
  • 到項目根目錄下,運行npm i gitbook-cli -g,然後創建SUMMARY.md
SUMMARY.md內容如下
* [項目介紹](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)
  • 運行gitbook init,創建各個文檔,完善各個文檔的內容。
  • 最後再修改根目錄下面的README.md,把文檔的鏈接加上
[如何使用](./doc/use/README.md)
[二次開發](./doc/dev/README.md)
  • 運行gitbook build 可以將md文件發佈爲html文件,默認放在_book文件夾下。
  • 運行npm run example,訪問http://localhost:8080/_book可以查看效果
提交第一版本代碼
  • 首先在.gitigore文件上加一行_book,把打包出來的文件忽略掉。
  • 創建tag並提交
git tag -a 'v0.0.0' -m '第一版本'
git push origin v0.0.0

提交之後,下載地址就有了,https://github.com/fast-cache/fast-cache/releases 可以下載各個版本的代碼。

  • 最後要提交到npm上,讓使用者通過npm進行安裝。
//先登錄npm
npm add user
npm login
//發佈
npm publish .
升級代碼
  • 創建一個dev分支,不要在master分支上開發
  • 修改package.json版本號,按照之前既定的版本規則修改,不能亂改。
  • 修改代碼、文檔和測試用例
  • 自測
  • 將dev分支提交到遠程
git stadus //查看修改哪些東西
git diff //查看修改了哪些位置
git branch //查看當前是哪個分支
git checkout -b dev // 新建dev分支
代碼開發完成後,提交流程
  • 再次確認版本號,因爲版本非常重要。
  • 將dev合併到master,並提交master到遠程。
原先在dev分支上,先切換分支
git checkout master
git merge dev
git push origin master
  • 創建tag並提交到遠程。
git tag -a v0.0.3
git push origin v0.0.3
  • 提交到npm。
合併pr
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章