## 插件規范
### 通用規范
1. **插件內不可包含存在侵權的圖標、字體、代碼、文字、圖片、圖片中的文字、樣式或素材等**
2. 插件必須能在`后臺管理`\->`插件管理`正常離線安裝
3. 插件內請勿附帶任何推廣文字或鏈接
4. 插件內不能包含插件內子市場(遠程下載模塊)功能
5. 插件內不能包含加密的代碼
6. 插件內必須包含完整的代碼,不能提供額外鏈接用于下載其它資源
7. 插件非輔助類別插件功能不能過于單一
8. 插件必須提供完整的功能介紹、截圖和文檔
9. 插件內服務端代碼必須基于PSR-2規范進行編碼和格式化
10. 插件目錄、插件標識、數據庫前綴、菜單規則標識等必須一一匹配
11. 插件目錄控制器、模型、類、視圖等如有多個時必須使用層級,且層級的`頂層目錄`必須為`插件標識`
12. 插件安裝時不能覆蓋修改FastAdmin框架的核心文件和核心數據表結構
13. 插件目錄不能包含任何隱藏腳本文件
14. `public`目錄下不允許任何的`php/asp/jsp`等服務端腳本文件
15. 插件內API接口圖片和資源必須使用`cdnurl("地址", true);`進行補全URL前綴
16. 插件內如有使用自定義函數,請務必在自定義函數前加`插件標識_`或使用命名空間進行自定義函數
### 插件依賴規范
我們在開發插件中如果需要依賴到插件市場的插件時,需要注意以下依賴規范
1.如有必選依賴插件時,必須包含一款免費插件,確保基礎功能可用,例如`(編輯器、短信發送)`。
2.如有可選依賴插件時,應用插件可以是收費的,但插件在沒有安裝這些可選依賴插件時,必須能夠正常運行,以保證插件的靈活性和兼容性。
3.在開發自己的插件時,要盡量確保插件在沒有安裝可選依賴插件的情況下仍能正常運行,以提供更好的用戶體驗。
### 版本號規范
我們在開發FastAdmin應用插件時需做好版本號的更新和維護。
版本格式:`主版本號.次版本號.修訂號`
版本號遞增規則如下:
1.主版本號:當你做了不兼容的 API 修改。
2.次版本號:當你做了向下兼容的功能性新增。
3.修訂號:當你做了向下兼容的問題修正。
具體語義化規范請參考:https://semver.org/lang/zh-CN/
### 命名規范
具體命名規范可以參考:http://www.hmoore.net/manual/thinkphp5/118007