文档
4。文档
4.1 用英语记录你的跑步者
PostCSS参赛者必须README.md
用英文写作。不要害怕你的英语技能,因为开源社区将修复你的错误。
当然,欢迎您使用其他语言撰写文档; 只是恰当地命名它们(例如 README.ja.md
)。
4.2 维护更改日志
PostCSS运动员必须描述一个单独的文件的所有版本。变化,如ChangeLog.md
,History.md
或与 GitHub上发布。访问Keep A Changelog以获取有关如何编写其中一个的更多信息。
当然你应该使用SemVer。
4.3 postcss-runner关键字inpackage.json
为npm编写的PostCSS运行器必须在其中包含postcss-runner
关键字package.json
。此特殊关键字对于有关PostCSS生态系统的反馈非常有用。
对于未发布到npm的软件包,这不是强制性的,但如果允许软件包格式包含关键字,则建议使用此软件包。