Skip to content

armgit / anime

Public Imported from GitHub
0

JavaScript animation engine

Update issue templates

Julian Garnier96c681efed96
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 1105f349..c9777c2b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,34 +7,33 @@ assignees: ''
---
-**Make sure you're using an up to date version of Anime.js**
+**Make sure you're using an up-to-date version of Anime.js**
As a solo maintainer, I can't provide support for outdated versions of Anime.js.
**Describe the bug**
A clear and concise description of what the bug is.
+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.
+> [!IMPORTANT]
+> Do not post screenshots of your text editor.
+
+**Provide a minimal reproduction demo of the bug**
> [!IMPORTANT]
-> **Provide a minimal reproduction demo of the bug**
->
> You can fork this [CodePen template](https://codepen.io/juliangarnier/pen/pvoGoxR) or use a similar service to provide a minimal reproduction so I can quickly follow the steps to reproduce your problem.
-**To Reproduce**
-
-Steps to reproduce the behavior in the minimal reproduction demo:
+Detail the steps to reproduce the behavior in the minimal reproduction demo, for example:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-**Expected behavior**
+And if possible, add a screen recording of the bug in action to help explain your problem.
-A clear and concise description of what you expected to happen.
-
-**Screenshots or screen recordings**
+**Describe the expected behavior**
-If possible, add screenshots or screen recordings to help explain your problem.
+A clear and concise description of what you expected to happen.
**Environment details**
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index bbcbbe7d..b5e015b5 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,14 +7,21 @@ assignees: ''
---
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Only suggest one feature request per issue**
+If you want to suggest multiple features, create different issues for each one and make sure the feature hasn't been discussed or is already being discussed somewhere else.
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe what the feature does**
+A clear and concise description of what the feature request is trying to solve or improve.
+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.
+
+**Provide a code example of what the feature should look like**
+A clear and concise description of what you want to happen, with an example of how the API should look like.
+
+> [!IMPORTANT]
+> **Do not post screenshots of your text editor.** Paste the code directly in the issue with the adequate code formatting.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screen recording about the feature request here.