Icon Link贡献指南

感谢您对 Fuel Wallet 的贡献感兴趣!本文档概述了安装依赖项和设置 Fuel Wallet 进行开发的过程,以及一些改进贡献的约定。

如果您在入门时遇到任何困难,随时可以在我们的Discord Icon Link上提问。

Icon Link寻找工作内容

您可以通过多种方式为 Fuel Wallet 项目做出贡献,其中一些涉及编码知识,另一些则不需要。以下是一些例子:

  • 报告错误
  • 为已有的开放问题添加新功能或错误修复
  • 提出功能请求

查看我们的需要帮助 Icon Link初学者友好问题 Icon Link来找到合适的任务。

如果您计划做一些大的改动,例如涉及多个组件或更改当前行为,请确保在开始实施之前打开一个问题 Icon Link与我们讨论。

Icon Link贡献流程

以下是贡献者工作流程的大致概要:

  • 确保您要贡献的内容已经作为问题被追踪。
    • 我们可能会在问题中讨论问题和解决方案。
  • 从您要基于的分支创建一个 Git 分支。通常是 master 分支。
  • 编写代码,添加适用的测试用例,并提交您的工作。
  • 运行测试,确保所有测试通过。
  • 为您的 PR 添加一个 changeset
    • pnpm changeset - 按提示操作并在末尾添加更改描述
    • pnpm changeset:empty - 如果没有包被提升
  • 如果 PR 包含任何重大更改,请在您的 PR 上添加 breaking 标签。
  • 将更改推送到您仓库中的一个分支,并提交一个拉取请求。
    • 在您的 PR 标题中使用以下标签之一:
      • feat: - 新功能
      • fix: - 错误修复
      • docs: - 仅文档更改
      • style: - 不影响代码含义的更改(空格、格式、缺少的分号等)
      • refactor: - 既不修复错误也不添加功能的代码更改
      • perf: - 改善性能的代码更改
      • test: - 添加缺失的测试或更正现有的测试
      • build: - 影响构建系统或外部依赖的更改(例如 scopes: gulp, broccoli, npm)
      • ci: - 更改 CI 配置文件和脚本(例如 scopes: Travis, Circle, BrowserStack, SauceLabs)
      • chore: - 其他不修改 src 或测试文件的更改
      • revert: - 撤销先前的提交
    • 确保在提交消息中提到在第 1 步中创建的问题。
  • 您的 PR 将被审查,可能会请求一些更改。
    • 一旦您进行了更改,您的 PR 必须重新审查并批准。
    • 如果 PR 过期,您可以使用 GitHub 的“更新分支”按钮。
    • 如果有冲突,您可以在本地合并并解决它们。然后推送到您的 PR 分支。 对分支的任何更改都需要重新审查。
  • 我们的 CI 系统(Github Actions)会自动测试所有授权的拉取请求。
  • 一旦获得批准,使用 GitHub 合并 PR。

感谢您的贡献!

Icon Link关联问题

拉取请求应至少与同一仓库中的一个问题关联。

如果拉取请求解决了相关问题,并且您希望 GitHub 在合并到默认分支后自动关闭这些问题,可以使用以下语法(关键字 #问题编号):

close #123

如果拉取请求关联一个问题但不关闭它,可以使用关键字 ref

ref #456

多个问题应该使用每个问题的完整语法并用逗号分隔,如:

close #123, ref #456