This page documents the issue reporting system for anime.js, including the three issue types (bug reports, feature requests, documentation updates), their templates, and submission guidelines. For information about contributing code through pull requests, see Pull Request Guidelines. For general development setup, see Development Setup.
The anime.js project uses GitHub Issues with structured templates to manage bug reports, feature proposals, and documentation improvements. All issues must follow predefined templates or they will be closed until they comply with the guidelines CONTRIBUTING.md3-4
The project distinguishes between issues and discussions:
The project maintains three issue templates in the .github/ISSUE_TEMPLATE/ directory:
| Template File | Issue Type | Title Prefix | Label |
|---|---|---|---|
bug_report.md | Bug Report | [BUG] | bug |
feature_request.md | Feature Request | [FEATURE] | feature proposal |
documentation-update.md | Documentation Update | [DOCS] | documentation |
Sources: CONTRIBUTING.md6-16 .github/ISSUE_TEMPLATE/bug_report.md1-8 .github/ISSUE_TEMPLATE/feature_request.md1-8 .github/ISSUE_TEMPLATE/documentation-update.md1-8
Sources: CONTRIBUTING.md6-16
The bug report template at .github/ISSUE_TEMPLATE/bug_report.md consists of three main sections:
Sources: .github/ISSUE_TEMPLATE/bug_report.md1-30
The first section requires a clear, concise description of the bug .github/ISSUE_TEMPLATE/bug_report.md10-14 The template explicitly warns against:
A critical requirement is providing a minimal reproduction using the official CodePen template at https://codepen.io/pen?template=pvoGoxR .github/ISSUE_TEMPLATE/bug_report.md16-18 This allows maintainers to quickly reproduce and debug the issue.
Detailed steps must follow this format .github/ISSUE_TEMPLATE/bug_report.md20-29:
1. In Chrome 138
2. Open this [demo](https://codepen.io/pen?template=pvoGoxR)
3. Click on '....'
4. Scroll down to '....'
5. See error
Screen recordings are optional but helpful for complex bugs.
Sources: .github/ISSUE_TEMPLATE/bug_report.md10-30
The feature request template at .github/ISSUE_TEMPLATE/feature_request.md has four sections:
Sources: .github/ISSUE_TEMPLATE/feature_request.md1-23
A clear description of what problem the feature solves or what it improves .github/ISSUE_TEMPLATE/feature_request.md10-12 The same LLM warning applies: keep text concise and meaningful.
Must provide a code example showing how the proposed API should look .github/ISSUE_TEMPLATE/feature_request.md14-16:
Document any alternative solutions considered .github/ISSUE_TEMPLATE/feature_request.md18-22 and provide additional context such as:
Sources: .github/ISSUE_TEMPLATE/feature_request.md10-23
The documentation update template at .github/ISSUE_TEMPLATE/documentation-update.md is the simplest template with two main sections:
| Section | Purpose | Requirements |
|---|---|---|
| Describe the Update | What to change, improve, or add | No text screenshots, paste text with formatting |
| Suggested Modification | Actual correction or addition | Concise, meaningful text |
Sources: .github/ISSUE_TEMPLATE/documentation-update.md10-17
The template emphasizes .github/ISSUE_TEMPLATE/documentation-update.md10-17:
Sources: .github/ISSUE_TEMPLATE/documentation-update.md1-17
Sources: CONTRIBUTING.md3-16 .github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/feature_request.md .github/ISSUE_TEMPLATE/documentation-update.md
The project strictly enforces template compliance CONTRIBUTING.md3-4:
Issues and PRs created without following the guidelines listed below will be closed until they match the expected template.
All issue templates emphasize proper code formatting:
Sources: .github/ISSUE_TEMPLATE/bug_report.md14 .github/ISSUE_TEMPLATE/feature_request.md16 .github/ISSUE_TEMPLATE/documentation-update.md12
Multiple templates include warnings about LLM-generated text:
If you're using an LLM to write the issue, please make sure that the
text actually means something, and please, keep it short, LLMs tend
to write longer texts than needed.
This applies to:
Sources: .github/ISSUE_TEMPLATE/bug_report.md13 .github/ISSUE_TEMPLATE/feature_request.md12 .github/ISSUE_TEMPLATE/documentation-update.md16
| Scenario | Use | Reasoning |
|---|---|---|
| Code doesn't work as expected | Bug Report Issue | Requires debugging and fixing |
| Propose new animation method | Feature Request Issue | Requires implementation and API design |
| Fix typo in README | Documentation Update Issue | Requires content correction |
| How do I animate SVG paths? | Q&A Discussion | Question about usage, not a bug |
| Why was feature X designed this way? | General Discussion | Not requesting a change |
| Performance optimization idea | Feature Request Issue | Specific improvement proposal |
| Documentation is unclear | Documentation Update Issue | Needs content improvement |
Sources: CONTRIBUTING.md6-16
When a bug report is created, the development workflow follows CONTRIBUTING.md23-32:
npm i/src files with JSDoc annotations/test/suites/npm run test-browser to verify fixdev branch referencing the issueFeature request issues must exist before PR submission CONTRIBUTING.md25:
Make sure your PR has a bug report or new feature proposal issue associated with it. If not, create one.
Sources: CONTRIBUTING.md18-33
The issue templates link to external GitHub resources:
| Resource | URL Purpose | Referenced In |
|---|---|---|
| Code Formatting Guide | GitHub's markdown formatting docs | Bug report template |
| CodePen Template | codepen.io/pen?template=pvoGoxR | Bug report template |
| Q&A Discussions | Category-specific discussion creation | Contributing guide |
| GitHub Sponsors | Project funding page | Contributing guide |
Sources: .github/ISSUE_TEMPLATE/bug_report.md14-24 CONTRIBUTING.md13-36
Refresh this wiki