Convert issue template to a form

This commit is contained in:
Marcin Kulik
2025-06-23 21:32:42 +02:00
parent 8f01e17dc7
commit 1a4ac6519c
2 changed files with 104 additions and 40 deletions

View File

@@ -1,40 +0,0 @@
---
name: Bug report
about: Create a report to help improve asciinema CLI
title: ''
labels: ''
assignees: ''
---
To make life of the project maintainers easier please submit bug reports only.
This is a bug tracker for asciinema cli (aka recorder).
If your issue seems to be with another component (js player, server) then open an issue in the related repository.
If you're experiencing issue with asciinema server at asciinema.org, contact admin@asciinema.org.
Ideas, feature requests, help requests, questions and general discussions should be discussed on the forum: https://discourse.asciinema.org
If you think you've found a bug or regression, go ahead, delete this message, then fill in the details below.
-----
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. ...
2. ...
3. ...
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Versions:**
- OS: [e.g. macOS 12.6, Ubuntu 23.04]
- asciinema cli: [e.g. 2.4.0]
**Additional context**
Add any other context about the problem here.

104
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@@ -0,0 +1,104 @@
name: Bug Report
description: Report a bug to help improve asciinema CLI
body:
- type: markdown
attributes:
value: |
**This is a bug tracker for asciinema CLI (the recorder).**
- If your issue is with the JavaScript player or server, please open an issue in the related repository
- If you're experiencing issues with asciinema.org, contact admin@asciinema.org
- For feature requests, questions, and discussions, use the [forum](https://discourse.asciinema.org) or [GitHub discussions](https://github.com/orgs/asciinema/discussions)
Thanks for taking the time to report a bug! Please fill out the sections below.
- type: textarea
id: bug-description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: Describe the bug...
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Steps to Reproduce
description: Provide detailed steps to reproduce the behavior
placeholder: |
1. Run command `asciinema ...`
2. Do action '...'
3. Observe error
value: |
1.
2.
3.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
placeholder: What should have happened instead?
validations:
required: true
- type: input
id: os-version
attributes:
label: Operating System
description: Which OS and version are you using?
placeholder: e.g., Ubuntu 24.04, macOS 14.0, Fedora 39
validations:
required: true
- type: input
id: cli-version
attributes:
label: asciinema CLI Version
description: What version of asciinema CLI are you using? Run `asciinema --version` to check.
placeholder: e.g., 2.4.0
validations:
required: true
- type: dropdown
id: installation-method
attributes:
label: Installation Method
description: How did you install asciinema CLI?
options:
- Package manager (apt, yum, brew, etc.)
- pip/pipx
- Built from source
- Downloaded binary
- Other
validations:
required: true
- type: textarea
id: terminal-info
attributes:
label: Terminal Information
description: What terminal emulator and shell are you using?
placeholder: |
Terminal: e.g., GNOME Terminal, iTerm2, Ghostty
Shell: e.g., bash 5.1, zsh 5.8, fish 3.6
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, screenshots, or relevant information about the problem here.
- type: checkboxes
id: terms
attributes:
label: Confirmation
options:
- label: I have searched existing issues to make sure this bug hasn't been reported already
required: true
- label: This is a bug report for asciinema CLI, not the web player or server
required: true