编辑页面

提交问题

在打开新的问题或评论此 GitHub 组织中任何代码库的现有问题时，请确保讨论与 Sails.js 软件的具体技术问题相关。功能请求和想法始终受欢迎，但不要以 GitHub 问题的形式提交。有关提交指南，请参阅下面的功能请求。

有关使用 Sails 的一般帮助，请参阅官方 Sails 文档。如需更多帮助，请在StackOverflow上提问或参考任何其他推荐的支持途径。

如果您在 Sails 或其任何依赖项中发现了安全漏洞，请勿在公开问题中报告。而是立即使用Sails 安全策略中详细说明的说明提醒核心维护人员。请遵守此请求，即使对于核心 Sails.js 团队未直接维护的外部依赖项（例如 Socket.io、Express、Node.js 或 openssl）。无论您是否认为核心团队可以做任何事情来解决问题，请按照我们的安全策略中的说明尽快私下披露漏洞。

最后，有关非技术性质的讨论，包括团队成员资格、商标、行为准则以及有关项目的较高层级问题或疑虑，应通过发送电子邮件至[email protected]直接发送给核心维护人员。

打开问题

Sails 由许多不同的子项目组成，其中许多子项目都有自己的专用代码库。即便如此，向 Sails 核心团队维护的模块提交疑似问题的最佳位置是在主 Sails 代码库中。这有助于我们掌握问题并保持组织有序。

在提交问题之前，请遵循以下简单说明

首先，在主 Sails 代码库中使用GitHub 搜索搜索与您类似的问题。

如果您的原始错误报告包含在现有的未解决问题中，则向该问题添加评论，而不是打开新的问题。
如果所有明确相关的问题都已关闭，则打开一个新问题，并将已关闭问题(s)的 URL 链接粘贴到底部。
如果您找不到任何相关问题，请尝试使用不同的搜索关键词（如果适用）（如果这会影响您的搜索方式，在撰写本文时，GitHub 使用基于 Lucene 的 ElasticSearch 来索引内容）。如果您仍然找不到任何相关的现有问题，则创建一个新的问题。
请考虑反向链接的重要性。响应您问题的贡献者几乎总是需要自己搜索类似的现有问题，因此将所有 URL 集中在一个地方可以节省大量时间。还要记住，从新问题进行反向链接会导致 GitHub 自动在新问题中插入已引用原始问题的 URL 链接。这非常有用，因为许多访问我们 GitHub 问题的访客来自搜索引擎。

确定应创建新问题后，

确保您的新问题不报告多个不相关的问题。
- 如果您遇到多个问题，并且这些问题明显不同，则为每个问题创建一个单独的问题，但从最紧急的问题开始。
- 如果您遇到多个相关问题（您只能同时重现的问题），则请仅创建一个问题。但是，请确保详细描述这两个问题，以及导致这两个问题都出现的步骤。
检查您的问题是否具有简洁、主题相关的标题，并使用礼貌、中性的语言尽可能地在可用空间内解释问题。问题的理想标题是在一目了然的情况下传达问题。
- 例如，"jst.js 在提升时从 layout.ejs 中删除" 是一个非常有帮助的问题标题。
- 以下是一些非示例，即无帮助的问题标题示例
  - "模板不起作用"：此标题过于模糊。即使无法获取更多信息，像"模板出现意外行为"这样的措辞也更具体，并且可能会更快地得到响应。
  - "应用程序已损坏，无法访问文件系统上的模板，因为它在资产管道中已损坏，请提供帮助"：此标题重复且包含不必要的内容（"请提供帮助"）。请记住，有用的标题既具有描述性又简洁。
  - "jst.js 正在被删除!!!!!!!!!"：此标题包含不必要的字母大写和标点符号，充其量是分散注意力的，并且可能被认为是不礼貌的。无论哪种情况，它都不太可能加快对您问题的响应。
  - "这个愚蠢、无用的框架是如何从我的应用程序中删除 jst.js 的？"：此标题包含不必要的消极情绪，这不利于参与者审查。尝试使标题尽可能客观，以获得最佳的问题解决体验。
  - "每次服务器崩溃时，我们当前部署的生产应用程序中的数千个文件都会损坏。"：此类语言可能被认为是夸张的，并且可能会降低您声明的可信度。在这种情况下，它甚至可能混淆问题（例如，“这是否仅在 NODE_ENV===production 时发生？”）。
在准备重现问题的步骤之前，尽可能地规范您个人开发环境上的许多变量
- 确保您已提升了正确的应用程序。
- 确保您已使用 CTRL+C 终止了 Sails 服务器并重新启动它。
- 确保您没有打开任何指向 localhost 的浏览器选项卡。
- 确保您没有在其他终端窗口中运行任何其他 Sails 应用程序。
- 确保您用于重现问题的应用程序具有干净的node_modules/目录，这意味着
  - 没有链接任何依赖项（例如，您没有运行npm link foo）
  - 您没有对node_modules/文件夹中的文件进行任何内联更改
  - 您没有任何奇怪的全局依赖循环。如果您不确定，最简单的方法是检查上述任何一项，运行：rm -rf node_modules && npm cache clear && npm install。
请记住提供您的应用程序正在使用的 Sails 版本（sails -v）。
- 请注意，这可能与您全局安装的 Sails 版本不同。
提供您当前安装的 Node.js 版本（node -v）、NPM 版本（npm -v）以及您正在运行的操作系统（OS X、Windows、Ubuntu 等）。
- 如果您使用nvm或其他 Node 版本管理器（如n），请务必在问题中提及。
提供从干净的 Sails 应用程序（即在没有特殊环境变量或.sailsrc文件的计算机上使用sails new创建的应用程序）重现问题的详细步骤。
最后，请花点时间思考您即将发布的内容以及其他 Sails 用户群如何解读它。确保它符合我们的行为准则，并确保您不会通过公开发布安全漏洞来危及其他 Sails 用户的安全。

不符合这些准则的问题通常会在未阅读的情况下关闭，并附有一条回复，要求提交者查看本贡献指南。如果这种情况发生在您身上，请意识到这与个人无关，并且它甚至可能再次发生。请了解 Sails 是一个大型项目，每月会收到数百个新的问题提交，我们非常感谢您抽出时间发布详细的问题。您越熟悉本贡献指南中列出的约定和基本规则，您未来的贡献对社区就越有帮助。您还将赢得核心团队成员的尊重，并为未来的贡献者树立榜样。