請怎樣開發及發報一個component在github上?

例如這個ionic3的日曆插件:

除了本身的ts+scss, 還有已編譯的css js,
code的最底層還有一堆說明文件,
除了push上github外,是否也要在npm上登記才可?
請問有沒有相關的教學?

唔該各位!

可以發佈成 npm packages 或是使用 npm 安裝 github 上的 repo ,兩種方法都可以
如果要包成 npm packages, 網路上應該有蠻多不錯的教學,可以找看看

大致說說,我也做了一個框架 Element Angular,希望能給你一點幫助。

  1. 你需要做一套編譯工具,把 TS / Sass / Image / Font 等等資源集合打包,調整好入口與類型文件 (@types),然後再開始開發,這是很關鍵的一步。它會決定你的開發體驗。

  2. github 作為最活躍的開發者社區,建議最好把代碼托管在上面,有 Bug / Feature 也能第一時間知曉。既然要在 github 上面存放項目, Readme / CI / Code style 等等東西都要自己弄好,具體你可以 google 這些關鍵詞琢磨。

  3. 在開發時,需要多對比其他 Component 有什麼區別,研讀別人的源碼,然後在各種邏輯的實現方式上總結出自己的一套理論。同時為了保證代碼質量和降低後期其他開發者參與進來的門檻,你還需要做一些 Lint 來強制約束代碼風格。

  4. 開發完成功能模塊後,你最好做一些測試和樣例,方便使用者觀察模仿。當然文檔也是必不可少的。這些工作做起來非常枯燥,並沒有寫代碼有成就感,但我認為這也是一個框架/庫成功的要點。

  5. 開發完成後你可以在 package.json 中指定自己需要發佈的目錄,然後登錄 npm (npm login),在運行發佈命令 (npm publish)。如果你希望更加細緻的控制版本,可以考慮結合 git 的 TAG / Release 來發佈。具體細節也可以 google 試試。發佈的時候記得最好先發一個 pre 版本,自己嘗試裝上運行一下,再發佈正式版本。

  6. 當你完成了前面 5 步之後可以大舒一口氣,後面都是一些維護與在 Issues 上討論的工作了,當然你也有可能發現並沒有什麽人用自己開發的框架/庫,這時候你可以學我這樣到處回復帖子,然後順便貼上 github 鏈接,曝光項目讓更多的人認識你。^ - ^

4個讚