为 RequireJS 做贡献

注意：RequireJS 的源代码可在 GitHub 上获取

对于规模超过一两行代码的修复

  1. 创建您自己的代码分支
  2. 在您的分支中进行更改
  3. 如果您喜欢这些更改，并且认为该项目可以使用它们
    1. 请确保您已遵循项目的代码风格。
    2. 与 jQuery 基金会签署贡献者许可协议 (CLA)。
    3. 请注意jQuery 基金会行为准则。
    4. 发送拉取请求，表明您已签署 CLA。

对于一两行代码的修复，您可以使用RequireJS GitHub 问题页面来指出问题。您也可以按照上述说明执行完整的分支/拉取请求操作，但对于一两行代码的修复，不需要签署 CLA。

为什么要签署 CLA？§ 1

CLA 在开源项目中很常见，其中 Apache 项目可能是最著名的。我们的目标是让 RequireJS 能够在尽可能多的项目中使用，而对于一些公司来说，只使用经过 CLA 批准的代码是最好的选择。

您仍然拥有您贡献内容的版权，CLA 只是为许可提供了最大的灵活性，并确保了知识产权的传承。您应该只提交您自己知识产权的补丁，而不是提交他人的知识产权。

其他可能有用的阅读材料

代码风格§ 2

JSLint 用于检查代码风格。它还有助于避免一些错误。JSLint 上的默认设置应该可以使用，特别是使用 4 个空格进行缩进，不要使用制表符。

所有变量和文件名都应使用驼峰式命名法。避免使用下划线作为单词分隔符。这也扩展到 CSS 类名、测试 HTML 文档中的 ID 等所有内容。

每个 JS 文件顶部都可以指示一些 JSLint 的例外情况，但应尽可能避免使用它们。您可能会在源代码中看到两个常见的例外情况

  • **nomen: false**，允许在某些属性/变量/函数名称的开头使用下划线。
  • **plusplus: false**，但这仅允许使用递增 ++ 值的循环。应避免其他使用 ++ 的情况。