Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.34 KB

contributing.md

File metadata and controls

24 lines (19 loc) · 1.34 KB

贡献指南

请注意,跟这个项目一起发布的还有一个贡献者行为准则。只要参与这个项目,就表示你同意遵守其中的条款。

  • 不要在 README 上做修改,而是在 SOURCE.md 文件上。

确保你的 pull request 符合以下准则:

  • 在提出一个新的建议之前先搜索一下以前的建议,因为你的建议可能是重复的。
  • 建议包应该经过测试并且有文档描述。
  • 每个 pull request 都应该有一个有意义的标题,并且包含一个指向包或者是资源的链接,以及为什么它很棒。
  • 每个建议都要提一个单独的 pull request。
  • 使用以下格式:[资源](链接)— 描述 [作者](作者页面的链接)
  • 使用 title-casing(美联社英语新闻写作风格)。
  • 新增的内容应该添加到相关分类的底部。
  • 欢迎提出新的分类或对现有的分类进行改进。
  • 链接到 GitHub 仓库,而不是 npmjs.com 之类的地址。
  • 保持描述简短且清晰。
  • 不要在描述中提及自我量化的内容或是包含各种暗示。
  • 描述要以大写字母开头。
  • 检查你的拼写和语法。
  • 确保你的文本编辑器设置为删除结尾的空白。

谢谢你的建议!