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

animate-css/animate.css

菜单

问题和拉取请求模板

相关源文件

目的与范围

本文档提供了 Animate.css 存储库中使用的 issue 和 pull request 模板的技术概述。这些模板标准化了贡献者报告 bug、请求功能以及提交代码更改的方式。有关一般贡献工作流和指南的信息，请参阅贡献指南。

模板架构

Animate.css 实现了 GitHub 的 issue 模板功能，为贡献者提供结构化表单。这些模板可确保维护者收到一致且完整的信息，以便高效地处理 issue。

来源：.github/ISSUE_TEMPLATE/bugs.yml .github/ISSUE_TEMPLATE/features.yml

Bug Report Template

Bug report template 以 YAML 格式定义，创建一个结构化表单，指导贡献者提供有关遇到问题的基本信息。

模板结构

Bug report template 包含以下关键部分：

字段必填目的
Bug Description是对 bug 是什么的清晰解释
Steps to Reproduce否重现问题的编号步骤
预期行为否What should happen instead
屏幕截图否问题的视觉证据
Desktop Environment否操作系统、浏览器和版本详情
Mobile Environment否设备、操作系统、浏览器和版本详情
附加上下文否Any other relevant information

来源：.github/ISSUE_TEMPLATE/bugs.yml5-73

Field Specifications

Bug 描述模板使用结构化 YAML，其中包含特定的字段类型和验证要求。

来源：.github/ISSUE_TEMPLATE/bugs.yml1-75

功能请求模板

Feature request template 能够让贡献者以结构化的方式提出新的功能或改进，帮助维护者理解其背景和价值。

模板结构

Feature request template 包含以下关键部分：

字段必填目的
问题描述是Description of the issue the feature addresses
Solution Description是Proposed implementation or approach
Alternatives Considered是Other approaches that could solve the problem
附加上下文否Any other relevant information

来源：.github/ISSUE_TEMPLATE/features.yml5-36

Field Specifications

Feature request template 的结构强调了理解拟议增强功能背后背景的重要性。

来源：.github/ISSUE_TEMPLATE/features.yml1-37

Integration With GitHub Interface

Templates通过 GitHub 的 issue 创建工作流展示给贡献者，该工作流将 YAML 定义转换为交互式表单。

来源：.github/ISSUE_TEMPLATE/bugs.yml1-4 .github/ISSUE_TEMPLATE/features.yml1-4

技术实现

Templates 使用 GitHub 的 issue form schema，这是一种基于 YAML 的配置格式。实现遵循 GitHub 的特定语法，包含以下关键组件：

  1. Metadata Section：定义模板名称、描述和默认标签。
  2. Body Section：包含字段定义，其中：
    • 字段类型（当前所有字段均为 textarea）
    • 每个字段的唯一 ID
    • 属性（标签、描述、占位符）
    • 验证规则

Template Schema Example

每个模板都遵循此通用结构。

name: [Template Name]
description: [Template Description]
labels: [Default Labels]
body:
- type: [Field Type]
  id: [Field ID]
  attributes:
    label: [Field Label]
    description: [Field Description]
    placeholder: [Example Content]
  validations:
    required: [true/false]

来源：.github/ISSUE_TEMPLATE/bugs.yml1-73 .github/ISSUE_TEMPLATE/features.yml1-36

贡献者最佳实践

使用这些模板时，贡献者应遵循以下技术指南：

  1. Bug 报告:

    • 提供 bug 发生的 Animate.css 的具体版本。
    • 如有可能，请包含最小化的复现代码。
    • 提及仅在特定环境中出现的浏览器特定问题。

  2. 功能请求:

    • 在提议新动画功能时，请参考现有的动画功能。
    • 考虑性能影响，特别是对于复杂的动画。
    • 评估与现有 API 设计的兼容性。

结论

Animate.css 中的 issue 和 pull request 模板提供了一种结构化的方法来收集贡献者信息。通过实施这些模板，项目维护者可以更有效地对社区贡献进行分类、归档和处理，同时确保信息的连贯性和完整性。