Lily58项目社区贡献指南：如何参与开源键盘开发

Lily58项目社区贡献指南：如何参与开源键盘开发

【免费下载链接】Lily586×4+4keys column-staggered split keyboard.项目地址: https://gitcode.com/gh_mirrors/li/Lily58

Lily58是一款6×4+4键的列错位分体式开源键盘项目，为机械键盘爱好者提供了高度可定制的硬件设计和固件支持。本指南将详细介绍如何参与Lily58项目的社区贡献，从环境搭建到代码提交的完整流程，帮助新手轻松入门开源键盘开发。

为什么选择贡献Lily58项目？

参与Lily58项目不仅能提升你的硬件设计和固件开发技能，还能为全球机械键盘爱好者社区贡献力量。该项目拥有多个版本，包括Pro、Lite Rev3等，每个版本都有独特的设计特点和改进空间。无论是PCB设计优化、固件功能增强还是文档翻译，都能找到适合自己的贡献方向。

Lily58 Lite Rev3分体式键盘实物展示，采用白色键帽搭配红色和灰色功能键，展现出简洁而专业的设计风格

贡献前的准备工作

1. 环境搭建

首先需要克隆Lily58项目仓库到本地：

git clone https://gitcode.com/gh_mirrors/li/Lily58

项目主要使用KiCad进行PCB设计，QMK固件进行键盘功能开发。确保安装以下工具：

• KiCad 6.0及以上版本（用于PCB设计和修改）
• QMK固件开发环境（用于键盘功能开发）
• Git（用于版本控制）

2. 了解项目结构

Lily58项目包含多个版本和相关资源，主要目录结构如下：

• Pro/和Pro_V2/：专业版PCB设计文件和文档
• Lite_Rev3/：简化版Rev3的设计文件和图片
• pcb/：旧版PCB设计文件
• doc/：项目文档

贡献方向与具体步骤

硬件设计贡献

如果你擅长PCB设计，可以参与以下工作：

1. PCB设计优化

Lily58的PCB设计文件采用KiCad格式，位于各版本目录下，如Lite_Rev3/Lily58_Lite_Rev3.kicad_pcb。你可以：

• 优化布线以减少信号干扰
• 增加新的功能模块（如额外的LED灯）
• 改进PCB布局以提高组装便利性

Lily58 Pro V2版本的PCB设计图，展示了左右分体式布局和精密的线路设计

2. 元件库更新

项目的元件库位于pcb/Lily58-footprint.pretty/目录，包含各种自定义封装。如果你发现缺少必要的元件封装，可以创建新的.kicad_mod文件并提交。

固件开发贡献

Lily58使用QMK固件，你可以通过修改固件来增加新功能或改进现有功能：

1. 自定义键盘映射

QMK固件允许高度自定义的键盘映射。你可以创建新的键盘映射文件，添加宏功能、层切换等高级功能，并提交到qmk_firmware/keyboards/lily58/keymaps/目录。

2. 功能模块开发

开发新的功能模块，如OLED屏幕显示优化、RGB灯效控制等，并通过Pull Request提交到主仓库。

文档贡献

完善的文档对新手用户至关重要，你可以参与以下文档工作：

1. 文档翻译

项目已有多语言文档，如Pro/Doc/buildguide_en.md（英文）、doc/buildguide_jp.md（日文）。你可以将这些文档翻译成其他语言，或改进现有翻译。

2. 教程编写

编写新的教程，如"初学者入门Lily58组装指南"、"QMK固件自定义教程"等，帮助新手快速上手。

贡献流程

1. Fork项目仓库

在GitCode上Fork Lily58项目到自己的账户。

2. 创建分支

从主分支创建新的分支，用于开发你的功能或修复：

git checkout -b feature/your-feature-name

3. 开发与测试

进行代码开发或文档编写，并进行充分测试。对于硬件设计，建议使用KiCad的DRC（设计规则检查）功能确保设计合规。

4. 提交Pull Request

将你的分支推送到远程仓库，并在GitCode上创建Pull Request，详细描述你的贡献内容。

社区交流与支持

参与Lily58项目的社区交流，获取帮助和反馈：

• 项目文档：各版本目录下的README.md文件，如Lite_Rev3/README.md
• 问题反馈：通过项目仓库的Issue功能提交bug报告或功能建议
• 开发讨论：参与项目的讨论区，与其他开发者交流想法

Lily58 Lite Rev3版本的电路原理图，展示了键盘的电气连接和元件布局

贡献者注意事项

• 遵循项目现有的代码风格和文档格式
• 提交前确保所有修改都经过充分测试
• 在Pull Request中清晰描述修改内容和目的
• 尊重其他贡献者的意见，积极参与代码审查

无论是硬件设计、固件开发还是文档编写，每一份贡献都能帮助Lily58项目不断完善。加入我们，一起打造更优秀的开源键盘！

【免费下载链接】Lily586×4+4keys column-staggered split keyboard.项目地址: https://gitcode.com/gh_mirrors/li/Lily58