为 JavaScript SDK 做贡献

为 Dapr JavaScript SDK 做贡献的指南

当对JavaScript SDK做出贡献时，应该遵循以下规则和最佳实践。

💡你可以运行npm pretty-fix来对所有文件运行prettier

提交指南

Dapr 的 JavaScript SDK 使用 Conventional Commits 规范。 自动变更日志工具使用这些来根据提交消息自动生成变更日志。 下面是编写提交消息的指南，以允许这样做：

格式

type(scope)!: subject

  • type: 提交的类型是以下之一：

    • feat: 新功能。
    • fix: Bug 修复。
    • docs: 文档变化。
    • refactor: 重构某个特定的代码部分，不引入新功能或错误修复。
    • style: 代码风格改进。
    • perf：性能改进。
    • test：对测试套件的更改。
    • ci: CI 系统的变化。
    • build：对构建系统的更改（我们还没有，所以这不应该适用）。
    • chore: 用于其他不符合先前类型的变化。 这在更改日志中不会显示。

  • scope: 提交所修改的代码库的部分。 如果它对许多部分进行了修改，或者没有特别的部分被修改，请留出空白，不要加括号。 示例:

    • 添加 test 的提交：
    test(actors): add an actor test
    • 提交一次会改变很多事情：
    style: adopt eslint

    对于示例的更改，范围应该是带有 examples/ 前缀的示例名称：

    • ❌ fix(agnoster): commit subject
    • ✅ fix(examples/http/actor): commit subject

  • !：这在scope（或者如果scope为空，则在type）之后，表示提交引入了破坏性的变化。

    可选地，您可以指定一个消息，更改日志工具将向用户显示，以指示发生了什么变化以及他们可以采取什么措施来处理它。 您可以使用多行来键入此消息; 更改日志解析器将继续读取，直到提交消息结束或找到空的行。

    编造的例子：

    style(agnoster)!: change dirty git repo glyph

BREAKING CHANGE: the glyph to indicate when a git repository is dirty has
changed from a Powerline character to a standard UTF-8 emoji.

Fixes #420

Co-authored-by: Username <email>

  • subject: a brief description of the changes. 这将显示在更改日志中。 如果您需要 指定其他细节，您可以使用提交主体，但它不会可见。

    格式化技巧：提交主题可能包含：

    • 通过编写 #issue 链接到相关问题或 PR。 更改日志工具将突出显示这一点：

      feat(archlinux): add support for aura AUR helper (#9467)

    • 使用反引号格式化内联代码：反引号之间的文本也将通过更改日志工具以突出显示：

      feat(shell-proxy): enable unexported `DEFAULT_PROXY` setting (#9774)

样式

尽量保持第一个提交行简短。 使用这种提交风格很难做到这一点，但尽量做到简洁，如果你需要更多空间，你可以使用提交主体。 尝试确保提交主题足够清晰和精确，以便用户只需查看更改日志即可知道发生了什么更改。

Github Dapr Bot命令

请查阅daprbot文档，了解您可以在此存储库中运行的Github命令，用于常见任务。 例如，您可以运行/assign命令（作为对问题的评论）将问题分配给一个用户或一组用户。

编码规则

为确保整个源代码的一致性，请在工作时牢记以下规则：

  • 所有功能或错误修复必须由一个或多个规范（单元测试）测试。
  • 所有公共 API 方法必须记录在案。
  • 我们遵循 ESLint 推荐规则。

示例

examples 目录包含了一些代码示例，供用户运行，以尝试各种 JavaScript SDK 包和扩展的特定功能。 在写新的和更新的示例时，请牢记。

  • 所有的例子都应该可以在 Windows、Linux 和 macOS 上运行。 虽然JavaScript代码在操作系统中是一致的，但任何前/后示例命令都应该通过codetabs提供选项。
  • 包含下载/安装任何所需先决条件的步骤。 使用全新安装的操作系统的人，应该能够在没有错误的情况下启动这个例子并完成它。 指向外部下载页面的链接是正常的。

文档

daprdocs 目录包含渲染到Dapr Docs网站的markdown文件。 当文档网站建立后，该仓库会被克隆和配置，使其内容与文档内容一起呈现。 编写文档时牢记：

  • 除了这些规则外，还应遵循文档指南中的其它规则。
  • 所有文件和目录都应该以 js- 为前缀，以确保所有文件/目录名称在所有 Dapr 文档中是全局唯一的。