每個真正的程序員,可能都會夢想着能夠發布開源項目,讓自己的代碼被別人所用。開源項目會發布到開發的版本管理系統(比如GitHub)上面,為了讓大家能夠方便使用你的代碼,項目的目錄結構應該遵循一定的規范。即使不是開源項目,項目目錄結構符合一定的規范對你的項目管理也是有好處的。
下面列出python開源項目的通常目錄結構及說明:
.tx/ 如果你使用Transifex進行國際化的翻譯工作,創建此目錄config Transifex的配置文件$PROJ_NAME/ 按照你實際的項目名稱創建目錄。如果有多個子項目,就創建多個目錄docs/ 項目文檔wiki/ 如果有wiki,可以創建此目錄scripts/ 項目用到的各種腳本tests/ 測試代碼extras/ 擴展,不屬於項目必需的部分,但是與項目相關的sample、poc等,下面給出4個例子:dev_example/production_example/test1_poc/test2_poc/.gitignore 版本控制文件,現在git比較流行AUTHORS 作者清單INSTALL 安裝說明LICENSE 版權聲明MANIFEST.in 裝箱清單文件MAKEFILE 編譯腳本README 項目說明文件,其他需要的目錄下也可以放一個README文件,說明該目錄的內容setup.py python模塊的安裝腳本
這個目錄結構是針對python項目的,
各種語言習慣的目錄結構可能不同,但一些基本的要素還是共同的,可以舉一反三。