MPV播放器项目代码贡献指南

MPV播放器项目代码贡献指南

mpv 🎥 Command line video player 项目地址: https://gitcode.com/gh_mirrors/mp/mpv

前言

MPV作为一款优秀的开源媒体播放器，其开发过程遵循严格的代码规范和贡献流程。本文将详细介绍如何为MPV项目贡献代码，包括代码风格、提交规范、版权要求等内容，帮助开发者更好地参与项目开发。

代码提交规范

提交信息格式要求

1. 标题格式：必须包含子系统前缀和简短描述

   • 错误示例：fixed the bug (wtf?)
   • 正确示例：af_volume: fix crash due to null pointer access

2. 正文要求：

   • 使用现在时态描述变更后的情况
   • 使用过去时态描述变更前的情况
   • 每行不超过72个字符
   • 标题与正文间空一行

3. 内容深度：

   • 包含所有非显而易见的细节
   • 提供足够上下文以便未来调试
   • 避免过于简略的描述

提交内容组织

1. 逻辑拆分：

   • 将独立变更拆分为多个提交
   • 功能变更与样式调整分开提交
   • 每个提交应代表一个完整的逻辑变更

2. 修复提交处理：

   • 使用git rebase -i压缩修复提交
   • 保持PR处于可合并状态
   • 复杂变更可保留多个提交但需明确标记

代码风格规范

基础格式要求

1. 缩进与空格：

   • 使用4个空格缩进（禁止使用Tab）
   • 操作符前后添加空格
   • 示例：

     if ((a * b) > c) {
         some_function(a, b, c);
     }
     

2. 行长度限制：

   • 建议80列换行
   • 硬限制100列
   • 特殊情况可适当放宽

控制结构规范

1. 大括号使用：

   • 多行语句必须使用大括号
   • if-else结构必须使用大括号
   • 示例：

     if (a) {
         one_line();
     } else {
         one_other_line();
     }
     

2. 长条件处理：

   • 多行条件将左大括号放在新行
   • 示例：

     if (very_long_condition_a &&
         very_long_condition_b)
     {
         code();
     }
     

版权与许可要求

1. 许可协议：

   • 新代码必须采用LGPLv2.1+协议
   • 兼容许可（如BSD、MIT）可双重许可
   • 文件头部的许可声明具有法律效力

2. 作者声明：

   • 必须确认代码原创性或注明来源
   • 企业贡献需注明版权归属
   • 禁止使用虚假姓名

3. 注意事项：

   • 不要将姓名添加到许可头
   • 确保所有贡献者被正确署名

技术实现规范

语言特性使用

1. 标准遵循：

   • 使用C11标准（禁用VLA和复数类型）
   • 避免非标准GNU C特性
   • #pragma once作为例外允许使用

2. 平台兼容性：

   • 仅使用C11或POSIX保证的函数
   • 考虑Windows/MinGW兼容性
   • 新增功能需进行配置检查

3. 现代实践：

   • 提倡声明与初始化结合
   • 避免C90风格的顶部声明

苹果平台开发

1. 语言选择：

   • 新功能使用Swift而非Objective-C
   • 现有Objective-C代码可保留
   • C API可保持或转为Swift

2. 框架使用：

   • Cocoa等面向对象API优先使用Swift
   • 完全重写应采用Swift

接口变更管理

1. 文档要求：

   • 用户可见变更需更新手册
   • 命令行选项变更记录于options.rst
   • libmpv API变更需更新头文件文档

2. 变更策略：

   • 不兼容变更需创建说明文件
   • 文件命名与变更内容相关
   • 变更类型需明确标注（添加/移除/弃用等）

3. 版本管理：

   • interface-changes.rst仅在大版本更新时修改
   • 相关变更可分组说明

最佳实践建议

1. 开发流程：

   • 重大变更前先在开发频道讨论
   • 避免重复工作和不必要的修改
   • 保持代码整洁和一致性

2. 测试要求：

   • 提交前必须充分测试
   • 未测试需在提交信息中说明
   • 考虑边缘情况和跨平台行为

3. 协作规范：

   • 尊重现有代码风格
   • 及时响应代码审查意见
   • 保持专业和友好的交流态度

通过遵循这些规范，开发者可以更高效地为MPV项目贡献代码，同时确保项目保持高质量和一致性。在提交前，建议仔细检查是否符合所有要求，这将大大提高代码被接受的可能性。

mpv 🎥 Command line video player 项目地址: https://gitcode.com/gh_mirrors/mp/mpv