MJRefresh 开源贡献指南：如何提交 PR 与修复框架 Bug

MJRefresh 开源贡献指南：如何提交 PR 与修复框架 Bug

【免费下载链接】MJRefresh An easy way to use pull-to-refresh. 项目地址: https://gitcode.com/gh_mirrors/mj/MJRefresh

贡献前准备

环境搭建

首先需要克隆项目仓库到本地开发环境：

git clone https://gitcode.com/gh_mirrors/mj/MJRefresh

项目核心代码位于 MJRefresh/ 目录下，包含基础组件和自定义刷新控件。建议使用 Xcode 打开 MJRefresh.xcodeproj 进行开发，项目结构如图所示：

代码规范

贡献代码需遵循以下规范：

• 使用 ARC 内存管理
• 代码风格保持与现有代码一致，参考 MJRefreshComponent.h 中的注释风格
• 新增功能需提供对应的示例代码，放置在 Examples/ 目录下

提交 PR 流程

1. 创建分支

从 main 分支创建功能分支，命名格式建议为 feature/功能描述 或 bugfix/问题描述：

git checkout -b feature/custom-header-animation

2. 实现功能或修复 Bug

根据需求修改代码，以下是常见的贡献场景：

添加自定义刷新控件

参考 MJDIYHeader.h 和 MJDIYHeader.m 实现自定义刷新控件。新控件应继承自基础组件类，如：

@interface MJCustomHeader : MJRefreshStateHeader
// 自定义属性和方法
@end

修复现有 Bug

若发现刷新控件布局异常，可检查 UIView+MJExtension.h 中的布局相关方法。例如调整 mj_x、mj_y 等属性的计算逻辑。

3. 编写测试用例

所有功能变更都需要添加对应的测试，测试代码放在 MJRefreshExampleTests/ 目录下。例如为新的下拉刷新样式添加测试：

- (void)testCustomHeader {
    MJCustomHeader *header = [MJCustomHeader headerWithRefreshingBlock:^{
        // 测试逻辑
    }];
    XCTAssertNotNil(header);
}

4. 提交代码并创建 PR

提交代码时需编写清晰的提交信息，格式建议为 [类型] 描述，例如：

git commit -m "[Feature] Add custom header with progress indicator"
git push origin feature/custom-header-animation

然后在 GitCode 平台上创建 Pull Request，标题需简洁明了，描述中应包含：

• 功能或修复的详细说明
• 测试步骤
• 相关截图（如适用）

修复框架 Bug 实例

问题分析

假设发现 MJRefreshAutoFooter 在某些情况下不会自动触发加载更多，需要定位问题。

首先查看 MJRefreshAutoFooter.h 中的自动刷新逻辑，关键属性 automaticallyRefresh 控制是否自动刷新：

@property (assign, nonatomic, getter=isAutomaticallyRefresh) BOOL automaticallyRefresh;

检查相关实现文件 MJRefreshAutoFooter.m，发现当 triggerAutomaticallyRefreshPercent 设置过大时可能导致无法触发。

修复方案

调整触发阈值的默认值，将 triggerAutomaticallyRefreshPercent 从 1.0 改为 0.5：

// 在 MJRefreshAutoFooter.m 中修改
self.triggerAutomaticallyRefreshPercent = 0.5;

验证修复

运行 MJRefreshExample 中的 MJTableViewController.m 示例，测试自动加载功能是否恢复正常。

贡献资源

官方文档

• 类结构说明：The Class Structure Chart of MJRefresh
• API 参考：MJRefreshComponent.h

示例代码

• 下拉刷新示例：MJTableViewController.m
• 上拉加载示例：MJCollectionViewController.m

社区支持

若有疑问可通过项目 README.md 中提供的联系方式与维护者沟通，或在 Issues 中提问。

注意事项

• 提交 PR 前确保所有测试通过
• 新增功能需更新 README.md 中的文档
• 涉及国际化的修改需同步更新 MJRefresh.bundle 中的多语言文件，如 en.lproj/Localizable.strings
• 若修改核心组件，需确保对现有用户的兼容性，参考 MJRefreshConfig.h 中的配置项

通过以上步骤，您可以顺利为 MJRefresh 贡献代码。我们欢迎任何形式的贡献，包括但不限于功能改进、Bug 修复、文档完善等。感谢您对开源项目的支持！

【免费下载链接】MJRefresh An easy way to use pull-to-refresh. 项目地址: https://gitcode.com/gh_mirrors/mj/MJRefresh