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

ryanoasis/nerd-fonts

菜单

错误报告

相关源文件

本文档提供了在 Nerd Fonts 项目中有效报告错误的全面指南。正确的错误报告对于帮助维护者及时识别、重现和修复问题至关重要。本页专门介绍错误报告流程；有关为代码库贡献修复的信息，请参阅贡献。

报告错误前

在提交新的错误报告之前，务必确认您的问题尚未被处理

  1. 搜索现有问题以避免重复
  2. 查看常见问题和故障排除页面获取解决方案
  3. 查阅维基以获取相关信息

这些报告前检查是错误报告模板中的必填字段，有助于维护一个有条理的问题跟踪器。

来源：.github/ISSUE_TEMPLATE/bug_report.yml5-11

错误报告流程

下图说明了从最初发现到解决的完整错误报告过程

来源：.github/ISSUE_TEMPLATE/bug_report.yml4-54

错误报告模板结构

Nerd Fonts 使用结构化的 GitHub 问题模板，以确保提供所有必要信息。了解此模板的关键组成部分将帮助您创建有效的错误报告

来源：.github/ISSUE_TEMPLATE/bug_report.yml4-54

需包含的关键信息

报告错误时，请包含以下关键信息，以帮助维护者快速理解和重现您的问题

字段描述示例
实际行为清晰描述您遇到的问题“Vim 图标在终端中显示损坏”
预期行为预期结果“Vim 图标应显示为备忘单中所示”
示例符号/文本导致问题的具体符号（如果可能，请提供码点）“U+E7C5（Vim 图标）渲染不正确”
所用字体精确的字体文件名“JetBrainsMono NF Regular.ttf”
字体来源字体获取途径“从 v2.3.0 版本下载”
终端模拟器您的终端应用程序和窗口标题“iTerm2 3.4.16，窗口标题：bash”
操作系统操作系统名称和版本“Ubuntu 22.04 LTS”
屏幕截图问题的视觉证据[显示问题的图片]

来源：.github/ISSUE_TEMPLATE/bug_report.yml13-53

有效错误报告的技巧

针对符号或字形问题

  1. 如果可能，请提供码点而非图片：码点（例如 U+E7C5）比截图更能精确识别特定字形。
  2. 指明哪个图标集包含有问题的字形：例如，“Devicons 集中的 Ruby 图标显示不正确。”
  3. 包含符号应出现的位置上下文：示例：“该图标应出现在 VS Code 的文件浏览器中 Ruby 文件旁边。”

针对字体安装或渲染问题

  1. 包含终端配置详情：如果您在终端中遇到问题，请提供有关终端字体设置的信息。
  2. 指定确切的字体变体：Nerd Fonts 为每个字体家族包含多种变体（Mono、Regular 等），因此请指定您正在使用的变体。
  3. 详细说明您的应用程序设置：如果问题出现在特定应用程序中，请包含该应用程序的相关字体配置。

截图最佳实践

  1. 显示完整上下文：包含足够的屏幕内容以显示问题发生的位置。
  2. 突出显示问题区域：明确截图的哪个部分显示了问题。
  3. 如果可能，请包含终端窗口标题：这有助于识别环境。
  4. 如果相关，请显示字体设置对话框：在适当时包含字体配置屏幕的截图。

来源：.github/ISSUE_TEMPLATE/bug_report.yml48-53

提交错误报告后

提交错误报告后

  1. 关注您的报告以获取回应：维护者可能会要求提供额外信息。
  2. 准备好测试潜在的修复：您可能会被要求在开发版本中测试修复。
  3. 用新发现更新您的报告：如果您发现额外信息，请将其添加到您的报告中。
  4. 保持耐心：根据问题的复杂性和可用资源，解决可能需要时间。

遵循这些指南，您将帮助 Nerd Fonts 维护者快速理解、重现和解决您的问题，从而为每个人改进项目。