Ladybird浏览器项目贡献指南与技术规范解析

Ladybird浏览器项目贡献指南与技术规范解析

ladybird Ladybird 是独立的浏览器项目，处于预 alpha 阶段。能浏览网页，采用多进程架构，图像解码、网络连接更稳健。 项目地址: https://gitcode.com/gh_mirrors/la/ladybird

项目概述

Ladybird浏览器是一个新兴的开源浏览器项目，采用现代C++23标准开发，致力于构建一个高性能、符合标准的网页浏览器。该项目由Ladybird Browser Initiative非营利组织主导，采用BSD-2-Clause许可证。

技术规范与开发准则

代码风格要求

项目采用严格的代码规范，开发者需注意以下要点：

1. 语言标准：必须使用C++23标准编写代码
2. 容器使用：统一使用项目自带的AK容器库
3. 格式化工具：必须使用clang-format 18进行代码格式化
4. 命名规范：变量、函数和类名需具有高度表达性
5. 代码质量：避免注释掉的代码，保持代码整洁

提交规范

项目对代码提交有严格要求：

1. 原子性提交：每个提交应只包含一个完整的功能或修复
2. 消息格式：
   • 首行格式为"分类: 简要描述"
   • 分类应为库、应用或服务的名称
   • 使用祈使语气（如"修改"而非"已修改"）
3. 消息内容：使用标准英语，注意拼写和标点
4. 行长度：提交消息每行不超过72个字符

开发流程建议

新手入门策略

1. 从小处着手：建议从小的功能或修复开始，逐步熟悉项目
2. 沟通先行：不确定方向时，应先讨论再开发
3. 测试驱动：尽可能为修改添加测试用例

测试要求

项目鼓励开发者：

1. 为所有新功能和错误修复添加测试
2. 考虑导入相关的Web Platform Tests (WPT)
3. 确保修改后的代码能通过现有测试套件

项目管理机制

问题追踪规范

1. 单一问题原则：每个问题只报告一个错误
2. 问题分类：
   • 不接受构建问题报告
   • 不接受支持请求
3. 讨论质量：避免无关评论和玩笑内容

代码审查流程

1. 审查请求：建议在Discord的#code-review频道宣传PR
2. 响应时间：紧急修改可直接联系维护者
3. 陈旧PR处理：21天无活动的PR会被标记，28天后关闭

语言与沟通规范

项目对各类文本内容有严格要求：

1. 官方语言：使用美式英语
2. 技术文档：
   • 使用权威和技术性的语气
   • 避免缩略语、俚语和习惯用语
3. 用户界面：
   • 使用中性代词
   • 避免幽默和讽刺
4. 度量单位：统一使用公制单位

开发工具配置

预提交钩子

项目提供了.pre-commit-config.yaml文件，可配置以下钩子：

1. pre-commit钩子：运行Meta/lint-ci.sh和Meta/lint-ports.py进行代码检查
2. post-commit钩子：验证提交消息格式

Git笔记功能

项目使用Git笔记功能记录额外信息：

1. 包含PR链接和审阅者信息
2. 需要额外配置才能查看完整日志信息

项目文化与价值观

1. 中立性原则：专注于浏览器开发，避免无关讨论
2. 协作精神：尊重不同背景的贡献者
3. 质量导向：对AI生成内容保持审慎态度

通过遵循这些规范，开发者可以更高效地为Ladybird浏览器项目做出贡献，同时确保项目保持高质量和一致性。

ladybird Ladybird 是独立的浏览器项目，处于预 alpha 阶段。能浏览网页，采用多进程架构，图像解码、网络连接更稳健。 项目地址: https://gitcode.com/gh_mirrors/la/ladybird