代码提交指南

在 Sails 核心代码库中，我们接受两种类型的代码贡献：补丁和新功能。

补丁 是小的修复，涵盖了从拼写错误到时间问题的所有内容。从文件顶部删除未使用的 require() 或修复导致 Travis 上主分支测试崩溃的拼写错误是两个很好的补丁示例。跨多个文件更改空白和变量名称的大型重构项目不属于补丁。此外，请记住，即使看似微不足道的更改，如果它影响了 Sails 文档化功能的使用，或者添加了未记录的公共函数，也不属于补丁。

新功能 是在 Sails 路线图 文件中总结的 TODO，并在相应的拉取请求中提供更多信息。任何不在 ROADMAP.md 文件中明确列出的内容都不应作为新功能提交。

如果您不确定您想进行的更改是否会被视为“补丁”，请在您开始编写拉取请求之前 在 问题跟踪器 中打开一个问题，或联系我们 核心团队 中的某个人在 Twitter 上。如果您计划进行大型工作，尤其要这样做。没有什么比看到您的辛苦工作付诸东流更令人沮丧的了，因为您的愿景与项目维护者的计划或正在进行的开发工作不一致。

一般规则

• 仅支持由 维护的 LTS 支持的 Javascript。 为了保持一致性，Sails 核心中的所有命令式代码，包括核心钩子和核心生成器，都必须用 JavaScript 编写，而不是 CoffeeScript、TypeScript 或任何其他预编译或转译语言。不要误会我们：我们认为在用户代码中使用 ES6、TypeScript 和/或 CoffeeScript 语法很棒，因为它可以提高您的生产力！但是，出于兼容性和一致性原因，我们不能合并拉取请求，除非它用维护的 LTS 支持的 JavaScript 编写。
• 不要自动格式化代码或尝试修复核心现有文件中感知的样式问题。
• 使每个拉取请求专注于一个目标，并尽可能少地更改 LoC/文件。
• 除非您是从一个非常清晰的提案开始的，否则不要提交实现新功能或增强现有功能的拉取请求。如上所述，没有什么比看到您的辛苦工作无法合并更令人沮丧的了，因为您的愿景与项目的维护者不一致。
• 在开始一个功能之前，一定要留下评论，告诉其他贡献者您正在处理该功能。请注意，如果您没有积极地向其他贡献者告知您的进展，您的沉默可能会被视为不活跃，其他人可能会开始他们自己关于该功能的工作。

贡献核心代码

Sails 核心中的子模块处于不同的 API 稳定性级别。错误修复（补丁）总是受欢迎的，但 API 或行为变更在没有经过认真计划的情况下无法合并，如上面有关功能提案的过程文档所述。

Sails 有几个在 package.json 文件中引用的依赖项，它们不属于项目本身。对这些依赖项或它们的依赖项的任何提议更改应发送到它们各自的项目（例如 Express、Socket.io 等）。请不要将您的补丁或功能请求发送到 Sails 代码库 - 我们无法接受或执行它。（虽然如果您通过聊天联系我们，我们会尽力提供帮助。）

贡献适配器

如果适配器是核心的一部分（代码库位于 Sails 代码库中），请遵循贡献 Sails 核心的通用最佳实践。如果它位于不同的代码库中，请将功能请求和补丁发送到那里。

编写新的适配器

Sails 适配器将 Waterline 查询语法转换为集成数据库的底层语言，它们从数据库获取结果并将它们映射到 Waterline（Sails 框架的 ORM）所期望的响应。虽然创建新的适配器不应该草率行事，但在许多情况下，编写适配器并没有想象中那么难（因为您最终会围绕一个现有的 npm 包进行包装），并且它是在 Sails 中的 ORM 钩子以及 Waterline 代码库中入门的好方法。

在开始编写新的适配器之前，只需确保在 npm、Google 和 Github 上进行彻底的搜索，以检查其他人是否已经开始处理相同的事情。在 概念 > 扩展 Sails > 适配器 中了解更多关于适配器的信息。

贡献钩子

如果钩子是核心的一部分（代码库位于 Sails 代码库中），请遵循贡献 Sails 核心的通用最佳实践。如果钩子位于不同的代码库中，请将功能请求、补丁和问题发送到那里。许多核心钩子都有 README.md 文件，其中包含对其目的、它们附加的方法、它们触发的事件以及有关其实现的其他相关信息的广泛文档。

编写新的钩子

创建钩子是实现 Sails 核心几乎任何事情的好方法。在开始编写新的自定义钩子之前，只需确保在 npm、Google 和 Github 上进行彻底的搜索，以确保其他人是否已经开始处理相同的事情。在 概念 > 扩展 Sails > 钩子 中了解更多关于自定义钩子的信息。

贡献生成器

如果生成器是核心的一部分（代码库位于 Sails 代码库中），请遵循贡献 Sails 核心的通用最佳实践。如果它位于不同的代码库中，请将功能请求、补丁和问题发送到那里。

编写新的生成器

自定义生成器 API 还没有完全稳定，但它正在趋于稳定。请随时开始编写新的自定义生成器，但首先确保在 npm、Google 和 Github 上进行彻底的搜索，以确保其他人是否已经开始处理相同的事情。自定义生成器是使用 Sails 代码库入门的好方法。