菜单

贡献

相关源文件

本页面介绍了如何为 Nerd Fonts 项目贡献,概述了不同类型的贡献、流程和应遵循的指南。有关专门添加或更新源字体的信息,请参阅源字体

贡献流程概述

Nerd Fonts 项目欢迎社区的各种形式的贡献。此图展示了整体贡献工作流程

来源:CONTRIBUTORS.md .all-contributorsrc

贡献类型

Nerd Fonts 认可各种类型的贡献,每种贡献都对项目的成功至关重要。该项目使用 All Contributors 规范来感谢所有贡献者,无论其贡献类型如何。

来源:.all-contributorsrc9-1880

设置开发环境

在为 Nerd Fonts 贡献之前,您需要设置开发环境,并安装必要的工具和依赖项。

所需工具

工具目的备注
Git版本控制所有贡献都必需
Python打补丁脚本使用推荐使用 Python 3.8+
FontForge字体操作字体打补丁必需
字体工具额外字体实用程序用于高级字体操作

进行代码贡献

代码贡献是帮助 Nerd Fonts 项目的重要方式。这可以包括改进字体打补丁脚本、添加新功能、修复错误或增强构建系统。

代码贡献工作流程

来源:CONTRIBUTORS.md .all-contributorsrc

文档贡献

文档对于用户有效理解如何使用 Nerd Fonts 至关重要。您可以通过改进 README、添加示例或撰写维基页面来为文档做出贡献。

常见文档领域

  • 安装说明
  • 字体使用指南
  • 字体打补丁教程
  • 工具文档
  • 故障排除指南

翻译贡献

Nerd Fonts 旨在让全球用户都能访问,因此文档翻译备受重视。

目前,README 已被翻译成多种语言

  • 中文
  • 西班牙语
  • 法语
  • 日语
  • 葡萄牙语
  • 波兰语
  • 俄语
  • 乌克兰语
  • 韩语

如果您精通其他语言,请考虑贡献翻译,以使 Nerd Fonts 更易于访问。

来源:.all-contributorsrc322-326 .all-contributorsrc417-424 .all-contributorsrc474-481

报告问题

错误报告有助于发现需要修复的问题。在报告问题时

  1. 检查问题是否已报告过
  2. 使用提供的议题模板
  3. 包含重现问题的详细步骤
  4. 提供有关您环境的信息
  5. 如果相关,请包含截图

拉取请求指南

提交拉取请求时

  1. 创建一个描述性分支名称
  2. 包含对更改的清晰描述
  3. 引用任何相关问题
  4. 确保所有测试通过
  5. 遵循现有代码风格
  6. 将范围集中在一个问题/功能上

贡献者鸣谢

Nerd Fonts 使用 All Contributors 规范来认可贡献者。一旦您的贡献被合并,您将被添加到 CONTRIBUTORS.md 文件中,该文件列出了所有项目贡献者及其贡献类型。

来源:CONTRIBUTORS.md1-286 .all-contributorsrc1-1889

贡献审查流程

所有对 Nerd Fonts 的贡献都将经过审查,以确保质量和一致性。

来源:.all-contributorsrc10-20 .all-contributorsrc435-445 .all-contributorsrc1605-1607 .all-contributorsrc1778-1780

贡献最佳实践

为提高您的贡献被接受的可能性

代码贡献

  • 遵循现有代码风格
  • 为新功能添加测试
  • 更新更改相关的文档

文档贡献

  • 使用清晰、简洁的语言
  • 在适当情况下包含示例
  • 确保格式正确

翻译贡献

  • 保持与原文相同的结构
  • 注重清晰度而非字面翻译
  • 如果可能,请由母语人士审阅

社区准则

参与 Nerd Fonts 社区时

  1. 尊重他人,包容开放
  2. 专注于建设性反馈
  3. 尽可能帮助他人
  4. 遵守行为准则

获取帮助

如果您在贡献过程中需要帮助

  1. 查阅现有文档
  2. 搜索类似问题
  3. 在 GitHub 讨论区提问
  4. 联系维护者

遵循这些指南,您可以有效地为 Nerd Fonts 项目做出贡献,并帮助为所有人改进它。