whichllm贡献指南：从提交issue到PR的完整开源协作流程

whichllm贡献指南从提交issue到PR的完整开源协作流程【免费下载链接】whichllmFind the local LLM that actually runs and performs best on your hardware. Ranked by real, recency-aware benchmarks, not parameter count. One command, run it instantly.项目地址: https://gitcode.com/GitHub_Trending/wh/whichllm想要为 whichllm 这个强大的本地LLM选择工具做出贡献吗本指南将详细介绍完整的开源协作流程帮助新手从零开始参与项目开发。whichllm 是一个基于实时基准测试的本地大语言模型推荐工具它能帮你找到在硬件上运行最佳的大语言模型。 为什么参与whichllm贡献whichllm 项目通过实时基准测试和智能硬件匹配帮助用户找到最适合自己硬件的本地大语言模型。参与贡献不仅能提升你的开发技能还能直接影响成千上万用户选择和使用AI模型的方式。 快速入门开发环境搭建一键安装步骤开始贡献前首先需要搭建开发环境git clone https://gitcode.com/GitHub_Trending/wh/whichllm cd whichllm uv sync --dev验证安装成功运行简单的测试命令确保环境配置正确uv run whichllm --help uv run pytest 如何提交有效的issue报告问题反馈最佳实践当遇到bug或发现问题时使用项目提供的issue模板能大大提高沟通效率。在提交issue前请确保包含以下关键信息硬件信息运行whichllm hardware获取详细硬件配置复现步骤清晰描述如何重现问题期望与实际行为明确说明预期结果和实际结果使用issue模板项目提供了标准化的issue模板位于 .github/ISSUE_TEMPLATE/bug_report.yml。模板会自动引导你填写必要信息问题描述复现步骤硬件信息Python版本操作系统whichllm版本 功能建议与改进提案新功能请求流程如果你有改进whichllm的想法可以使用功能请求模板。好的功能建议应该包含问题描述当前存在什么问题需要解决解决方案你建议如何实现这个功能替代方案考虑过的其他解决方案功能请求模板位于 .github/ISSUE_TEMPLATE/feature_request.yml。 代码贡献完整流程第一步Fork仓库首先fork主仓库到你的GitHub账户这是开源贡献的标准起点。第二步创建功能分支使用有意义的命名规范创建分支git checkout -b feature/your-feature-name git checkout -b fix/bug-description git checkout -b docs/documentation-update第三步进行代码修改在进行修改时请遵循项目代码规范使用类型提示type hints保持与现有代码风格一致为新功能添加测试用例第四步运行测试提交代码前必须运行测试uv run pytest测试文件位于 tests/ 目录包含了各种功能测试。 提交高质量的Pull RequestPR模板使用指南提交PR时请使用项目提供的PR模板位于 .github/PULL_REQUEST_TEMPLATE.md。模板包含四个关键部分What简要描述修改内容Why说明修改的原因和解决的问题Testing列出完成的测试项目Notes提供额外的上下文信息PR检查清单在提交PR前请确保✅ 所有测试通过✅ 新增功能有相应的测试用例✅ 代码风格与项目保持一致✅ 文档已相应更新✅ 硬件相关修改已在真实硬件上测试 特定贡献类型指南添加GPU支持如果要添加新的GPU到带宽数据库编辑 src/whichllm/constants.py 文件添加GPU规格信息。AI辅助代码贡献whichllm项目欢迎AI辅助的代码贡献项目理念是实用至上让代码工作适合项目便于审查。如果你使用AI工具编写代码请确保理解生成的代码测试关键部分准备好解释或修复代码文档改进文档是项目的重要组成部分。你可以改进现有文档如 docs/ 目录下的文件添加使用示例翻译文档如现有的日语文档 docs/README.ja.md 测试策略与最佳实践测试框架使用项目使用pytest作为测试框架。在编写测试时为新增功能编写单元测试硬件检测相关的测试位于 tests/test_hardware.pyCLI功能测试位于 tests/test_cli.py硬件测试注意事项如果贡献涉及硬件检测或GPU支持尽可能在真实硬件上测试考虑不同操作系统Linux、macOS、Windows的兼容性测试边缘情况和异常处理 社区协作与沟通行为准则参与贡献前请阅读 CODE_OF_CONDUCT.md了解社区行为规范。代码审查流程提交PR后维护者会进行代码审查。审查过程中可能会提出改进建议要求添加测试用例讨论技术实现细节请保持开放心态积极回应审查意见。持续集成项目使用GitHub Actions进行持续集成配置文件位于 .github/workflows/。每次提交都会自动运行代码风格检查单元测试集成测试 项目结构与代码组织了解项目结构能帮助你更快定位代码核心逻辑src/whichllm/硬件检测src/whichllm/hardware/模型处理src/whichllm/models/输出格式化src/whichllm/output/工具函数src/whichllm/utils.py 开始你的第一个贡献适合新手的任务如果你是第一次参与开源贡献可以从这些任务开始文档改进修复错别字改进说明文档测试用例为现有功能添加测试小bug修复修复简单的逻辑错误示例添加为功能添加使用示例获取帮助如果在贡献过程中遇到问题查看现有issue和PR寻找类似问题的解决方案在issue中详细描述问题参考项目文档和技术细节 贡献后的跟进跟踪进度提交PR后你可以定期检查CI运行状态及时响应审查意见根据需要更新代码合并后的工作PR合并后你的贡献会成为项目的一部分你可以继续关注相关功能的后续发展帮助回答其他用户关于你贡献功能的问题考虑参与更多功能开发 持续贡献与成长成为常规贡献者随着贡献经验的积累你可以参与更复杂的功能开发帮助审查其他人的PR参与项目路线图讨论技能提升通过参与whichllm项目你将获得开源协作经验Python开发技能硬件检测和AI模型相关知识测试驱动开发实践现在就开始你的whichllm贡献之旅吧每一个贡献无论大小都能帮助这个工具变得更好让更多人受益于智能的本地大语言模型选择。记住开源贡献不仅是写代码更是学习、协作和成长的过程。期待在项目中看到你的贡献【免费下载链接】whichllmFind the local LLM that actually runs and performs best on your hardware. Ranked by real, recency-aware benchmarks, not parameter count. One command, run it instantly.项目地址: https://gitcode.com/GitHub_Trending/wh/whichllm创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考