背景
為了方便廣大開發者們更好地使用組件,現對 MIP 組件庫統一進行升級,升級后將分為通用組件和自定義組件兩類,方便開發。
通用組件,即考慮了組件通用性方便所有開發者參考使用的組件,將存放于 mip-extensions 倉庫下,同時歡迎開發者貢獻通用組件,為 MIP 技術做貢獻,提交通用組件時,請通過 GitHub mipengine/mip-extensions提交。
自定義組件,即針對自己開發的站點進行自定義的組件,將統一存放在 mip-extension-platform 下。開發者提交新的自定義組件時,可以通過GitHub提交,也可以通過更便捷的組件平臺提交。若開發者自定義的組件,之前是以GitHub的形式提交,在此次升級后被遷移至了mip-extension-platform下,則仍在 GitHub mipengine/mip-extensions-platform上以 pull request 的形式來進行維護即可。
更具體的變化及要求見下文。
提交方式
- 原位于 mip-extension-platform 倉庫下的組件可以繼續走組件審核平臺進行提交。
- 從 mip-extensions 遷移過來的組件暫時從 mip-extension-platform 倉庫中提交 pull request 更新組件,緊跟后續我們會在組件審核平臺加入 GitHub 授權登陸,將組件與 GitHub 賬號進行關聯,從而通過 GitHub 賬號登陸即可在平臺提交代碼。
腳本引用變化
- 升級后 MIP 組件使用統一一套地址,即
https://c.mipcdn.com/static/v1/組件名/組件名.js
。 - 原組件審核平臺提交的腳本引用地址
https://c.mipcdn.com/extensions/platform/v1/組件名/組件名.js
可以得到兼容,站長無需進行任何修改,但后續頁面開發中必須以新地址進行引用。
如何貢獻通用組件
提交方式
通過 GitHub 在 mip-extensions 里提交 pull request,并由官方審核人員及時進行審核。
提交要求
- 使用原生JS編寫。
- 使用中文注釋。
- 組件必須遵守 MIP 組件規范,通過 MIP CLI 和 fecs 工具校驗。
- 功能必須通用,獨立,不摻雜任何業務邏輯。
- 符合MIP組件提交規范。