为 RequireJS 做出贡献

注意：RequireJS 的源代码可在 GitHub 上找到

如果更改内容超过一两行：

  1. 创建你自己的代码分支（fork）
  2. 在你的分支中进行更改
  3. 如果你喜欢这个更改并认为项目可以采用它：
    1. 确保你已经遵循了项目的编码风格.
    2. 签署jQuery 基金会的贡献者许可协议（Contributor License Agreement，简称 CLA）.
    3. 注意jQuery 基金会行为准则.
    4. 发送一个拉取请求（pull request），表明你已存档了一份 CLA。

对于一两行的修复，你可以使用RequireJS GitHub Issues 页面来指出问题。你也可以选择上述提到的完整分支/拉取请求流程，但对于一两行的修复不需要签署 CLA。

为什么需要 CLA？§ 1

CLA 在开源项目中很常见，其中 Apache 项目可能是最著名的例子。其目的是允许 RequireJS 被尽可能多的项目所使用，而对于一些公司来说，只使用经过 CLA 认可的代码是最合适的选择。

你仍然拥有你贡献代码的版权，CLA 只是提供了最大的许可灵活性，并确保了知识产权的来源清晰。你只应提交你自己知识产权的补丁，不应提交他人知识产权的内容。

可能对你有帮助的额外阅读材料：

编码风格§ 2

JSLint用于检查代码风格。它对于避免某些错误也很有用。JSLint 的默认设置通常已经足够好，特别是使用四个空格作为缩进，不要使用制表符。

所有变量和文件名都应使用驼峰命名法（camelCase）。避免使用下划线作为单词分隔符。这一点同样适用于 CSS 类名、测试 HTML 文档中的 ID 等所有相关内容。

每个 JS 文件顶部可以声明一些对 JSLint 的例外说明，但应尽可能避免使用这些例外。在源代码中你可能会看到两个常见的例外情况：

  • nomen: false，允许某些属性/变量/函数名称以开头的下划线。
  • plusplus: false，但仅限于允许 for 循环中使用递增的 ++ 值。其他方式的 ++ 使用应避免。