编辑页面

提交 Pull Request

本指南旨在帮助您开始为 Sails 框架做出贡献。它假设您已经熟悉 GitHub 的基本操作，但对所有级别的贡献者都很有用。

贡献指南

与任何开源项目一样，我们必须制定贡献指南，这有助于保护代码质量，并确保我们的框架保持健壮和可靠。出于这些原因，对 Sails 的所有贡献（无论是错误修复还是完整的全新功能）都必须遵循贡献协议。

在提交 Pull Request 之前，请确保

• 所有错误修复尽可能都有配套的测试。我们使用 Mocha 进行测试。
• 代码遵循我们的风格指南，以保持一致性（请参阅存储库中的 .jshint 和/或 .editorconfig 文件）。

如果您对当前部署的版本有紧急的热修复，请 在 GitHub 上发布问题 并提及 @mikermcneil。此外，在紧急情况下，请随时在 Twitter 上 @sailsjs。

现在我们都达成共识，让我们开始编写一些我们自己的精彩代码吧！:D

Fork

首先 fork 存储库

Clone

然后将您的 fork 克隆到您的本地文件系统中：git clone `[email protected]:YOUR_USER_NAME/sails.git`

更新

要将最新更改合并到您的 fork 中，请在您的项目目录中

git remote add core https://github.com/balderdashy/sails.git
git fetch core
git merge core/master

有关更多详细信息，请参阅 GitHub。

代码

进行您的增强，修复错误，做您的事。

测试

请为您的新增内容/修复编写测试。我知道如果您不习惯的话，这有点糟糕，但这是我们保持出色代码的方式。对于我们的测试套件，我们使用 Mocha。您可以使用 npm test 运行测试。有关更多信息，请参阅贡献指南中的“测试”部分。

Pull Request

完成后，您可以提交您的修复，推送您的更改，然后进入 GitHub 并提交 Pull Request。我们会查看它，并尽快回复您。

使用您的 fork 运行您的应用程序

如果您 fork 了 Sails，并且想要针对您的 fork 测试您的 Sails 应用程序，以下是如何操作

在您 fork 的 Sails 的本地副本中：sudo npm link

在您的 Sails 应用程序的存储库中：npm link sails

这将在您的应用程序的 node_modules 文件夹中创建一个符号链接作为本地依赖项。这样就可以让您使用您 link 的 Sails 版本运行您的应用程序。

$ sails lift

感谢您的贡献！