開源專案目錄規範

此為前端開發團隊遵循和約定的開源專案目錄規範，意在實現開源專案目錄結構的一致性。

說明

文件中使用的關鍵字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在RFC2119中被說明。

還未定稿，對規範中提及的點有不贊同的歡迎提出 issues (請新增目錄規範標籤)討論。

目錄規範

參加的目錄結構為：

.
├── .editorconfig
├── .travis.yml
├── css
├── dist
├── doc
├── README.md
├── src
 

README.md

每個專案都必須「MUST」包含一個README.md檔案，此檔案中應當「SHOULD」概要描述此專案的功能和特點等資訊。

.editorconfig

每個專案應當「SHOULD」包含.editorconfig，用來統一配置編輯器的換行、縮排儲存格式，使用方式請參考editorconfig是什麼？。

src

專案中所有 JS 原始碼應當「SHOULD」存放在此目錄下，且所有JS檔案編寫應當「SHOULD」遵循Javascript 編碼規範。

css、themes、less、sass

樣式類檔案存放應當「SHOULD」遵循以下規律，且檔案編寫應當「SHOULD」遵循

• 不帶主題的樣式檔案應當「SHOULD」統一存放在 css 目錄下面，且樣式中使用的背景圖片資源應當「SHOULD」統一存放在 css/images 目錄下面。
• 帶主題的樣式檔案應當「SHOULD」統一存放在 themes 目錄下對應的主題目錄下，預設的主題應當「SHOULD」採用 default 作為主題名稱，且應當「SHOULD」預設提供，樣式中對應圖片檔案應當「SHOULD」存放在樣式檔案所在的主題目錄下的 images 目錄下。
• less 格式的樣式檔案應當「SHOULD」統一存放在 less 目錄下面。
• sass 格式的樣式檔案應當「SHOULD」統一存放在 sass 目錄下面。

doc

所有專案應當「SHOULD」包含一個 doc 目錄，用來存放詳細的 API 使用文件。

dist

dist 作為專案輸出目錄，所有編譯生成、提供給使用者使用的檔案應當「SHOULD」存放在此目錄。

為了讓不太擅長 node.js 的使用者可以正常使用編譯後的程式碼，dist 目錄應當「SHOULD」包含基本輸出結果並提交在 github 中。

build

所有工具類指令碼應當「SHOULD」放在此目錄。

test

所有測試相關程式碼應當「SHOULD」放在此目錄。

src_cov

為了測試程式碼覆蓋率，所有為測試覆蓋率生成的新 JS 檔案應當「SHOULD」存放在此目錄下面。