问题报告和功能请求

相关源文件

• .github/ISSUE_TEMPLATE/bug_report.md
• .github/ISSUE_TEMPLATE/feature_request.md

本文档详细说明了如何正确地报告 anime.js 库中的问题并请求新功能。遵循这些指南有助于维护者高效地识别、重现和解决问题。有关向项目贡献代码的信息，请参阅 从源代码构建 和 测试。

问题管理流程概述

anime.js 项目使用 GitHub 的问题跟踪系统来管理缺陷报告和功能请求。项目为这两种类型的提交提供了特定的模板，以确保包含所有必要信息。

来源: .github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/feature_request.md

缺陷报告指南

缺陷报告有助于识别和修复库中的问题。一份结构良好的缺陷报告应包含清晰的重现步骤，以便维护者能够快速理解和解决问题。

缺陷报告的必需组成部分

来源: .github/ISSUE_TEMPLATE/bug_report.md

创建最小化重现示例

缺陷报告最重要的方面是提供一个能够重现该问题的最小化示例。项目为此目的专门提供了一个 CodePen 模板。

1. Fork 官方 CodePen 模板
2. 创建能够重现此缺陷的最简化示例
3. 移除任何与问题不直接相关的代码
4. 包含重现该行为的详细步骤
5. 考虑添加屏幕录制以阐明缺陷行为

来源: .github/ISSUE_TEMPLATE/bug_report.md20-30

环境信息

始终包含您的环境详细信息

信息	示例
操作系统	macOS, Windows 10, Ubuntu 22.04
浏览器	Chrome, Firefox, Safari
浏览器版本	120.0.6099.130
Anime.js 版本	3.2.1

来源: .github/ISSUE_TEMPLATE/bug_report.md36-41

功能请求指南

功能请求允许用户为 anime.js 提出新功能。结构良好的功能请求应包含清晰的使用案例和建议 API 的示例。

功能请求的必需组成部分

来源: .github/ISSUE_TEMPLATE/feature_request.md

撰写有效的功能请求

1. 每个问题只提交一个功能: 对多个功能创建单独的问题
2. 清晰描述问题: 解释该功能将解决或改进什么
3. 提供代码示例: 展示建议的 API 将如何在实践中运作
4. 考虑替代方案: 提及您考虑过的其他方法
5. 保持简洁: 清晰书写，避免不必要的冗长

来源: .github/ISSUE_TEMPLATE/feature_request.md10-27

问题模板结构

anime.js 项目使用 GitHub 问题模板来标准化提交。了解其结构有助于创建更有效的报告。

来源: .github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/feature_request.md

建议与不建议

建议

• ✅ 使用最新版本的 anime.js
• ✅ 创建最小化重现示例
• ✅ 提供清晰的分步说明
• ✅ 包含相关环境详细信息
• ✅ 撰写简洁、有意义的描述
• ✅ 在创建新问题之前检查现有问题

不建议

• ❌ 发布代码截图（请直接粘贴代码）
• ❌ 使用过时的库版本
• ❌ 在单个问题中提交多个功能请求
• ❌ 撰写过于冗长的描述（尤其是由 LLM 生成的文本）
• ❌ 遗漏重现步骤或演示

来源: .github/ISSUE_TEMPLATE/bug_report.md16-18 .github/ISSUE_TEMPLATE/feature_request.md15-21

支持项目

Anime.js 由一位依靠社区支持的开发者维护。如果您认为这个库对您的工作有价值，请考虑通过 GitHub 赞助成为赞助者。

来源: .github/ISSUE_TEMPLATE/bug_report.md43-45

问题生命周期

以下图表展示了问题从提交到解决的典型生命周期

来源: .github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/feature_request.md

结论

在报告问题和请求功能时遵循这些指南，将有助于确保您的提交得到高效处理。清晰的沟通和详尽的信息是帮助所有人改进 anime.js 的关键。