文件名称:module-style-guide:编写 JS 模块的风格指南
文件大小:2KB
文件格式:ZIP
更新时间:2024-07-17 09:50:02
模块风格指南 文件 LICENSE 始终为您的许可证创建一个单独的文件。 主要原因是没有人会抱怨没有许可证。 README.md 自述文件很重要! 一般来说,每个自述文件都应该有,按顺序: 说明包括: 目的 范围 特征 限制 资源包括: 论坛和聊天 维基 例子 维护者和合作者 代码示例包括: 安装 快速入门指南 API 文档 执照 不要打扰包括: 所有贡献者的列表 - 您可以查看 GitHub。 package.json 一定要包含在你的package.json : .repository - 如果你不设置这个,你很.repository 。 .files - 要包含的文件白名单。 最新版本的 npm 总是会自动捆绑自述文件、更改日志和许可证,因此无需添加这些文件。 唯一不使用它的时候是使用.npmignore更容易,这对于简单的模块来说很少见。 .browser
【文件预览】:
module-style-guide-master
----README.md(2KB)
----.gitignore(10B)