Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 分支
  • 提交
  • 创建拉取请求
  • 审查流程
  1. 贡献

拉取请求

上一页提交签名下一页=贡献审查程序

最后更新于1个月前

对应的

Pull Requests(拉取请求)是我们用来编写软件的主要机制。GitHub 有一些关于使用 Pull Request 功能的精彩。

分支

每个新功能或错误修复都应该在单独的分支上开发。分支允许您同时处理多个功能。在大多数情况下,您应该从 master 分支。但是,如果您与其他贡献者合作,我们通常会分支出一个长期存在的功能分支。长期存在的功能分支允许我们将单个功能分解为多个 PR,这些 PR 可以单独审查,但可以一起测试和发布。

作为 Bitwarden 贡献者,您应该分支 origin/master,这确保分支始终基于最新的上游 master 即使本地 master 已过时。

git checkout -b <team>/<issue-number>/<brief-description> -t origin/master

详细描述了我们的分支策略。

提交

我们建议将相关更改分组到单个提交中。这可以使审阅者更容易理解和评估所提议的更改,同时还可以为贡献者提供检查点,以便在出现问题时可以恢复。

我们没有关于如何构建提交消息(例如语义提交消息)的标准。我们鼓励提交消息应在 50 个字符的限制内,以便可以轻松使用 git log。如果提交消息需要超过 50 个字符,最好将其分解为更小的原子更改,以提高 git 历史记录的可读性和可延展性(还原、挑选等)。

更高级的贡献者可能会发现很有用。这允许贡献者在推送到远程存储库之前修改其本地历史记录。一个常见的用例是压缩多个半工作提交。请务必遵循强制推送建议。

PR 被审查后,就应避免强制推送。

影响现有 git 提交的 Git 操作会阻止 GitHub 正确识别 PR 的「新的更改」,迫使审阅者重新开始。

创建拉取请求

Bitwarden 存储库有一个应遵循的 Pull Request 模板。这将确保 PR 审核顺利进行,因为它将为审核者提供背景信息。创建社区 PR 后,它们将自动链接到内部 Jira 票证。内部票证用于确定优先级和跟踪目的。将 @dept-design 标记为任何 UI 更改的审阅者。

审查流程

虽然我们主要使用异步审查流程,但请随时安排与审查者/贡献者的会议来讨论更改。虽然异步通信很有用,但它会带来时间损失,从而拖延审查过程。有时,召开简短的电话会议来讨论更改可能会节省大量时间。

我们编写了一些,建议您在执行第一次代码审查之前阅读这些指南。

官方页面地址
文档
这里
重写历史
代码审查指南