菜单

为 Font Awesome 做贡献

相关源文件

目的与范围

本文档提供了为 Font Awesome 项目贡献的全面指南。内容涵盖了贡献工作流程、接受的贡献类型、行为准则以及拉取请求指南。有关提交特定类型贡献的信息,请参阅 提交图标请求报告错误请求功能拉取请求流程

行为准则

Font Awesome 维护着一份行为准则,以确保积极和包容的社区环境。所有贡献者在与项目互动时都应遵守这些标准。

关键标准

  • 使用欢迎和包容的语言
  • 尊重不同的观点和经历
  • 优雅地接受建设性批评
  • 关注对社区有益的事物
  • 对其他社区成员表示同情

不可接受的行为包括骚扰、网络钓鱼、诽谤性评论和其他不专业的行为。违规行为可向项目团队举报,邮箱地址为:hello@fontawesome.com

来源:CODE_OF_CONDUCT.md1-74

贡献工作流程

以下图示说明了 Font Awesome 的贡献工作流程

来源:CONTRIBUTING.md1-24

贡献类型

Font Awesome 接受以下类型的贡献

贡献类型模板描述
图标请求图标请求模板请求新的标准图标
品牌图标请求品牌请求模板请求新的品牌/Logo 图标
Web 错误报告Web 错误报告模板与 Kit、CSS 或 JS 实现相关的错误
桌面/原生错误报告其他错误报告模板桌面、原生和其他环境中的错误
功能请求功能请求模板新功能的建议

来源:CONTRIBUTING.md7-15

问题管理流程

以下图示展示了 Font Awesome 项目中问题的处理方式

来源:CONTRIBUTING.md7-15

拉取请求指南

Font Awesome 为拉取请求制定了具体准则

  • 图标 PRs:目前不接受包含图标的拉取请求
  • 优先级:不解决现有问题的 PR 被视为低优先级
  • 构建系统限制:大多数文件由构建系统生成,限制直接合并 PR
  • 保持更改的专注性:PR 应包含最小化、专注的更改
  • 浏览器测试:包含有关您的代码已在哪些浏览器中进行测试的信息

拉取请求审查流程

来源:CONTRIBUTING.md17-24

贡献要求

为了有效处理错误报告,必须满足以下条件

  1. 隔离性:问题必须特定于 Font Awesome,且不与外部因素相关
  2. 可复现性:必须提供复现错误的清晰步骤
  3. 可修复性:问题必须是可以在 Font Awesome 核心内解决的

对于所有贡献,都必须遵守行为准则,以维持积极的社区环境。

来源:CONTRIBUTING.md7-9 CODE_OF_CONDUCT.md14-32

贡献模板

Font Awesome 提供结构化的模板用于不同类型的贡献,以确保包含所有必要的信息。这些模板指导贡献者提供所需详细信息,以便 Font Awesome 团队能有效处理其提交。

问题模板结构

来源:CONTRIBUTING.md11-15

结论

为 Font Awesome 做出贡献是一个结构化的过程,旨在维护质量并高效地管理项目。虽然所有类型的贡献都受到欢迎,但存在特定的准则和限制,尤其是在包含图标的拉取请求方面。遵循提供的模板并遵守行为准则,可确保您的贡献得到考虑和有效处理。

有关特定贡献类型的更多详细信息,请参阅关于 提交图标请求报告错误请求功能拉取请求流程 的专门维基页面。