README

本出版物描述了一个适用于所有PHP包的标准文件系统骨架。

有关背景信息，请参阅https://github.com/php-pds/skeleton_research。

本标准中包含的用于验证或生成符合PDS规范的包的命令行工具在此处有文档：这里。

本出版物中使用的“必须”、“禁止”、“必需”、“应当”、“不应当”、“推荐”、“可能”、“可选”等关键词的含义，请参照RFC 2119。

摘要

包必须使用这些名称来命名这些根目录

包必须使用这些名称来命名这些根文件

包应该包含一个根文件，说明包内容的许可和版权条款。

根目录

bin/

如果包提供了一个用于命令行可执行文件的根目录，它必须命名为bin/。

本出版物未定义该目录的结构和内容。

config/

如果包提供了一个用于配置文件的根目录，它必须命名为config/。

本出版物未定义该目录的结构和内容。

docs/

如果包提供了一个用于文档文件的根目录，它必须命名为docs/。

本出版物未定义该目录的结构和内容。

public/

如果包提供了一个用于Web服务器文件的根目录，它必须命名为public/。

本出版物未定义该目录的结构和内容。

注意：此目录可能用作Web服务器的文档根目录。或者，文件可能通过其他代码动态提供，或复制或符号链接到“真实”的文档根目录，或者以其他方式管理，以便它们在互联网上公开可用。

resources/

如果包提供了一个用于其他资源文件的根目录，它必须命名为resources/。

本出版物未定义该目录的结构和内容。

src/

如果包提供了一个用于PHP源代码文件的根目录，它必须命名为src/。

本出版物未定义该目录的结构和内容。

tests/

如果包提供了一个用于测试文件的根目录，它必须命名为tests/。

本出版物未定义该目录的结构和内容。

其他目录

包可以包含其他根目录，用于本出版物未描述的目的。

本出版物未定义其他根目录的结构和内容。

根文件

CHANGELOG

如果包提供了一个根文件，列出了自上次发布或版本以来的更改，它必须命名为CHANGELOG。

它可能有一个小写文件扩展名来表示文件格式。

本出版物未定义文件的结构和内容。

CONTRIBUTING

如果包提供了一个根文件，描述了如何向包贡献，它必须命名为CONTRIBUTING。

它可能有一个小写文件扩展名来表示文件格式。

本出版物未定义文件的结构和内容。

LICENSE

虽然包的使用者可能在复制未经许可的知识产权时违反版权法，但包应包含一个根文件，说明包内容的许可和版权条款。

如果包提供了一个根文件，说明了包内容的许可和版权条款，它必须命名为LICENSE。

它可能有一个小写文件扩展名来表示文件格式。

本出版物未定义文件的结构和内容。

README

如果软件包提供了一个包含有关软件包本身信息的根级别文件，则该文件必须命名为README。

它可能有一个小写文件扩展名来表示文件格式。

本出版物未定义文件的结构和内容。

其他文件

软件包可能包含其他根级别文件，用于本出版物未描述的目的。

本出版物未定义其他根级别文件的结构和内容。