文件
4. 文档
4.1 用英语记录您的插件
PostCSS插件必须README.md用英文书写。不要害怕你的英语技能，因为开源社区将修复你的错误。
当然，欢迎您使用其他语言撰写文档; 只是恰当地命名它们（例如? README.ja.md）。
4.2 包括输入和输出示例
该插件README.md必须包含示例输入和输出CSS。一个明显的例子是描述插件如何工作的最佳方式。
第一部分README.md是放置示例的好地方。有关示例，请参阅postcss-opacity。
当然，如果您的插件不转换CSS，则此指南不适用。
4.3 维护更改日志
PostCSS插件必须描述他们在一个单独的文件中的所有版本，如变更CHANGELOG.md，History.md或? GitHub上发布。访问Keep A Changelog以获取有关如何编写其中一个的更多信息。
当然，你应该使用SemVer。
4.4 包含postcss-plugin关键字package.json
为npm编写的PostCSS插件必须在其中包含postcss-plugin关键字package.json。此特殊关键字对于有关PostCSS生态系统的反馈非常有用。
对于未发布到npm的软件包，这不是强制性的，但如果软件包格式可以包含关键字，则建议使用此软件包。
本文档系腾讯云开发者社区成员共同维护，如有问题请联系 cloudcommunity@tencent.com
