Eva Icons 完整贡献指南:如何提交高质量图标PR的设计规范与代码要求
Eva Icons 是一个包含超过480个精美开源图标库,支持SVG、Sketch、Web字体和动画效果。作为贡献者,了解项目的设计规范和代码要求至关重要,这能确保你的Pull Request顺利通过审查并被合并。🎯
Eva Icons 项目结构与核心文件
在开始贡献之前,先了解项目的基本结构:
- 图标文件目录:
package/icons/fill/svg/和package/icons/outline/svg/ - 构建脚本:
scripts/services/transform-icons.js负责图标转换 - 核心配置:
package/src/default-attrs.json包含默认图标属性
图标设计规范与命名约定
设计原则
所有图标必须遵循一致的设计语言:简洁、现代、易识别。图标使用2px的描边宽度,保持视觉统一性。
命名规则
- 填充图标:使用简单名称,如
heart.svg - 轮廓图标:使用
-outline后缀,如heart-outline.svg - 特殊变体:使用数字后缀,如
checkmark-circle-2-outline.svg
提交新图标的完整流程
1. 准备工作
首先克隆仓库到本地:
git clone https://gitcode.com/gh_mirrors/ev/eva-icons
cd eva-icons
2. 创建SVG图标文件
在正确的目录中创建SVG文件:
- 填充图标:
package/icons/fill/svg/ - 轮廓图标:
package/icons/outline/svg/
3. 遵循SVG代码规范
确保你的SVG代码符合项目标准:
- 使用
viewBox="0 0 24 24" - 移除不必要的属性
- 优化路径数据
- 确保可访问性
代码质量要求
SVG优化标准
- 移除注释和元数据
- 压缩路径数据
- 使用标准颜色值
- 保持语义化结构
测试与验证
在提交PR之前,确保:
- 图标在不同尺寸下清晰显示
- 与现有图标风格一致
- 在支持的浏览器中测试渲染效果
常见问题与解决方案
图标不显示
检查SVG文件是否位于正确的目录,并验证文件格式是否正确。
构建失败
确保遵循了所有构建脚本的要求,并检查是否有语法错误。
通过遵循这些规范,你将能够为Eva Icons项目贡献高质量的图标,并成为开源社区的重要成员!🚀
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



