菜单

提交图标请求

相关源文件

目的

本文档概述了向 Font Awesome 库提交新图标请求的流程。它涵盖了如何通过官方 GitHub issue 模板来提议标准图标和品牌图标。有关报告 bug 或请求功能的信息,请参阅 报告 Bug请求功能

来源: CONTRIBUTING.md7-15

图标请求类型

Font Awesome 接受两种主要的图标请求类型

  1. 标准图标请求 - 用于非品牌图标、表情符号、图标修饰符或改进
  2. 品牌图标请求 - 用于代表公司、产品或服务的徽标和品牌图标

每种类型都有单独的提交流程和要求。

来源: .github/ISSUE_TEMPLATE/000_icon_request.yml32-46 .github/ISSUE_TEMPLATE/001_brand_request.yml1-4

图标请求流程概述

下图说明了图标请求如何在 Font Awesome 生态系统中流动

来源: .github/ISSUE_TEMPLATE/000_icon_request.yml .github/ISSUE_TEMPLATE/001_brand_request.yml CONTRIBUTING.md11-12

提交标准图标请求

提交前检查清单

在提交标准图标请求之前,请确保您满足以下要求:

  • 该图标不代表品牌
  • 请求的是单个图标或匹配的一对
  • 您已搜索过现有的类似请求
  • 您了解新的图标请求是如何工作的

标准图标请求类型

Font Awesome 接受几种类型的标准图标请求:

请求类型描述
新图标一个全新的图标将被添加到库中
表情符号带有 Unicode 代码点的表情符号
魔法师修饰符可添加到现有图标的修饰符
图标改进现有图标的增强

提交流程

  1. 转到 图标请求模板
  2. 遵循标题格式:“图标请求:[图标名称]”
  3. 完成清单,确认您的请求符合要求
  4. 从下拉菜单中选择请求类型
  5. 提供详细的用例,解释图标将如何使用
  6. 包含视觉示例或参考以说明所请求的图标
  7. 提交 Issue

来源: .github/ISSUE_TEMPLATE/000_icon_request.yml7-59 CONTRIBUTING.md11

提交品牌图标请求

品牌请求要求

品牌图标请求有特定要求:

  • 必须是已建立的品牌,并有官方网站
  • 应包含品牌指南链接(如果可用)
  • 必须遵循标题格式:“品牌请求:[品牌名称]”

提交流程

  1. 转到 品牌请求模板
  2. 提供品牌描述以及为何应包含该品牌
  3. 包含官方网站 URL(必填)
  4. 如果可用,请链接到品牌指南
  5. 确认您已搜索过现有请求并了解流程运作方式
  6. 提交 Issue

来源: .github/ISSUE_TEMPLATE/001_brand_request.yml5-36 CONTRIBUTING.md12

请求评估流程

下图说明了 Font Awesome 如何评估和处理图标请求

来源: .github/ISSUE_TEMPLATE/000_icon_request.yml3-4 .github/ISSUE_TEMPLATE/001_brand_request.yml3-4

提交后

  1. 社区参与:其他用户可以点赞和评论您的请求以表示支持
  2. 团队审查:Font Awesome 团队会根据包括社区兴趣在内的各种因素来审查请求
  3. 状态更新:团队可能会要求提供额外信息或在 issue 上提供状态更新
  4. 实现:如果批准,该图标将被设计并包含在未来的版本中
  5. 通知:您将通过 GitHub 收到有关您的请求状态变化的通知

来源: .github/ISSUE_TEMPLATE/000_icon_request.yml27-28 .github/ISSUE_TEMPLATE/001_brand_request.yml35-36

重要提示

  • Pull Requests:Font Awesome 不接受包含图标的 Pull Requests
  • 图标向导:在提交请求前,检查您的图标是否可以使用 图标向导 创建
  • 重复请求:提交新请求前务必搜索现有请求
  • 响应时间:Font Awesome 团队收到大量请求;审查时间可能有所不同

来源: CONTRIBUTING.md19 .github/ISSUE_TEMPLATE/000_icon_request.yml12-13

成功图标请求的最佳实践

方面建议
描述明确清晰地说明图标的用途
用例提供详细的实际用例,说明图标将如何使用
视觉参考包含高质量的视觉示例,清晰地传达概念
研究检查图标是否已存在,或是否有类似的图标可以达到相同目的
耐心理解审查过程需要时间,并非所有请求都能实现

来源: .github/ISSUE_TEMPLATE/000_icon_request.yml47-59 .github/ISSUE_TEMPLATE/001_brand_request.yml10-15