在 Devin 中试用 DeepWiki 处理私有仓库
DeepWiki

FortAwesome/Font-Awesome

菜单

报告错误

相关源文件

目的与范围

本文档提供了在 Font Awesome 中报告 Bug 的详细指南。它涵盖了提交 Bug 报告的正确流程、所需信息以及提交报告后的后续操作。重点在于报告 Font Awesome 库本身的技术问题，而不是请求新图标或功能（如需请求图标，请参见提交图标请求，如需请求功能，请参见请求功能）。

何时报告 Bug

当您在 Font Awesome 中遇到与 Font Awesome 核心相关且可隔离、可复现的问题时，应提交 Bug 报告。在报告 Bug 之前，请确保：

  1. 问题与 Font Awesome 的功能相关，而非您的实现有关
  2. 您能够稳定地重现问题
  3. 您已搜索现有问题以避免重复提交

来源：CONTRIBUTING.md7-9

Bug Report Types

Font Awesome 接受两种类型的 Bug 报告，具体取决于问题发生的地点

  1. Web Bug：在使用 Font Awesome 的 CSS、JavaScript 或 Kit 实现的 Web 应用程序中出现的问题
  2. Desktop/Native Bug：在桌面应用程序、设计软件或其他非 Web 环境中出现的问题

来源：CONTRIBUTING.md13-14 .github/ISSUE_TEMPLATE/100_web_bug_report.yml1-3 .github/ISSUE_TEMPLATE/101_other_bug_report.yml1-3

Bug Report Process Flow

以下图表说明了 Bug 报告从提交到分类再到解决的流程

来源：.github/ISSUE_TEMPLATE/100_web_bug_report.yml5-81 .github/ISSUE_TEMPLATE/101_other_bug_report.yml5-42 CONTRIBUTING.md11-15

Reporting a Web Bug

对于在使用 Font Awesome 的 Web 应用程序中出现的 Bug，请遵循以下步骤

  1. 访问 Font Awesome GitHub repository
  2. 点击“Issues”，然后点击“New Issue”
  3. 选择“Bug report (Web - CSS - JS)”
  4. 填写表单并提供所有必需信息

Web Bug 的必需信息

信息描述必填
Bug 描述详细说明问题以及如何重现是
可重现的测试用例codepen.io、jsfiddle.net、jsbin.com、codesandbox.io 等平台的 URL推荐要求
屏幕截图问题的视觉证据推荐要求
Font Awesome 版本受 Bug 影响的版本（例如：v6.0.0）是
提供方式Kit、Font Awesome CDN、自托管或其它是
实现CSS、SVG+JS、SVG Sprites 或其它是
浏览器和操作系统受影响的浏览器和操作系统列表是

来源：.github/ISSUE_TEMPLATE/100_web_bug_report.yml15-73

创建可重现的测试用例

可重现的测试用例将大大增加修复 Bug 的可能性。请遵循以下指南创建有效的测试用例

  1. 使用 CodePen、JSFiddle、JS Bin 或 CodeSandbox 等平台
  2. 仅包含演示 Bug 所需的最少代码
  3. 确保 Font Awesome 版本与您遇到 Bug 的版本一致
  4. 提供清晰的重现问题的步骤
  5. 包含预期结果与实际结果的对比

来源：.github/ISSUE_TEMPLATE/100_web_bug_report.yml22-26 .github/ISSUE_TEMPLATE/100_web_bug_report.yml78-79

Reporting a Desktop/Native Bug

对于在桌面应用程序、设计软件或其他非 Web 环境中出现的 Bug，请遵循以下步骤

  1. 访问 Font Awesome GitHub repository
  2. 点击“Issues”，然后点击“New Issue”
  3. 选择“Bug report (Desktop / Native / Other)”
  4. 填写表单并提供所有必需信息

Desktop/Native Bug 的必需信息

信息描述必填
Bug 描述详细说明问题以及如何重现是
Font Awesome 版本受 Bug 影响的版本（例如：v6.0.0）是
应用程序和操作系统受影响的应用程序和操作系统列表是
测试用例演示问题的步骤或文件推荐要求

来源：.github/ISSUE_TEMPLATE/101_other_bug_report.yml10-34

Bug Report Information Structure

以下图表说明了每种 Bug 报告所需信息的结构

来源：.github/ISSUE_TEMPLATE/100_web_bug_report.yml15-73 .github/ISSUE_TEMPLATE/101_other_bug_report.yml10-34

What Happens After You Submit a Bug Report

提交 Bug 报告后，将发生以下过程

  1. 报告将被自动标记为“bug”和“needs-triage”
  2. Font Awesome 团队将在分类阶段审查报告
  3. 信息完整的报告（尤其是可重现的测试用例）将获得更高的优先级
  4. 分类后，有效的 Bug 将在开发过程中得到处理
  5. 已修复的 Bug 将包含在未来的发行版中

对于重要或紧急的问题，提供详细的报告和可重现的测试用例是确保及时关注和解决的最佳方式。

来源：.github/ISSUE_TEMPLATE/100_web_bug_report.yml4 .github/ISSUE_TEMPLATE/101_other_bug_report.yml4

Tips for Effective Bug Reports

为了最大程度地加快 Bug 被处理的速度

  1. 具体且简洁 - 清晰地描述问题，避免不必要的细节
  2. 包含可重现的测试用例 - 这将大大增加 Bug 被修复的可能性
  3. 检查重复项 - 报告前请搜索现有问题
  4. 提供环境详细信息 - Font Awesome 版本、浏览器/操作系统或应用程序/操作系统信息
  5. 包含视觉证据 - 在适用情况下提供截图或录屏
  6. 描述预期行为与实际行为 - 应该发生什么以及实际发生了什么
  7. 列出重现步骤 - 按编号列出重现问题的步骤

来源：.github/ISSUE_TEMPLATE/100_web_bug_report.yml8-14 .github/ISSUE_TEMPLATE/101_other_bug_report.yml8-9

Common Bug Categories

了解常见的 Bug 类别有助于您更有效地报告问题

  1. 渲染问题 - 图标显示不正确或不显示
  2. 样式问题 - CSS 冲突或外观异常
  3. 功能故障 - JavaScript 功能未按预期工作
  4. 性能问题 - 加载或渲染性能下降
  5. 兼容性问题 - 与特定浏览器或应用程序的问题
  6. 集成问题 - 与框架或特定环境一起使用 Font Awesome 时出现的问题

报告时，请指明您的问题属于哪个类别，以便更有效地进行故障排除。

来源：CONTRIBUTING.md7-9