在GitHub上放置自己的项目时,没有固定的规定要求必须放几个文件夹,分别对应什么内容,一些常用约定组织结构如下:
--项目根目录:通常包含项目的核心文件和文件夹,如README.md、LICENSE、.gitignore等。
--src 或 source:源代码的主要存放位置,通常会包含项目的主要逻辑和实现。
如果你的项目是分模块的,你可能会在这个文件夹下为每个模块创建子文件夹。
--docs 或 documentation:用于存放项目的文档,如用户手册、开发者文档、API文档等。
--tests 或 spec:存放测试脚本和测试数据,用于验证项目的功能和性能。
--examples:示例代码和项目的演示,帮助新用户更快地理解和使用项目。
--assets 或 resources:用于存放项目所需的静态资源,如图片、音频、视频文件、配置文件等。
--bin 或 build:编译后的二进制文件或构建产物。
--configs 或 configuration:存放项目的配置文件,如数据库连接信息、环境变量等。
--.github:这个文件夹通常包含GitHub特定的文件,如ISSUE_TEMPLATE.md(定义新问题的模板)、PULL_REQUEST_TEMPLATE.md(定义拉取请求的模板)等。
--其他:plugins、extensions、locales等。