Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
name: 🐞 Bug Report
description: File a bug report to help us improve TinyPixels.
title: "[Bug]: "
labels: ["type: bug", "status: needs-triage"]
assignees:
- nafasebra
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please provide as much detail as you can.

- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. callmeali@duck.com
validations:
required: false

- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear and concise description of what the bug is.
placeholder: Tell us what you see!
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Provide steps to reproduce the behavior, including the exact command you ran.
placeholder: |
1. Run 'tinypixels ./images -q 85'
2. See error...
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: dropdown
id: version
attributes:
label: TinyPixels Version
description: What version of TinyPixels are you running? (Run `tinypixels --version`)
options:
- latest (from git)
- 1.0.0
- 0.9.0
- older
validations:
required: true

- type: input
id: python-version
attributes:
label: Python Version
description: What Python version are you using? (`python --version`)
placeholder: ex. Python 3.9.7
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating System
description: Which OS are you running TinyPixels on?
options:
- Windows
- macOS
- Linux
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output (e.g., error messages, compression summary). This will be automatically formatted into code.
render: shell

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nafasebra/tinypixels/blob/main/CODE_OF_CONDUCT.md) (if available)
options:
- label: I agree to follow this project's Code of Conduct
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 🤔 Questions & Discussions
url: https://github.com/nafasebra/tinypixels/discussions
about: Please ask and answer questions here, or start a general discussion.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: 📄 Documentation
description: Report missing, unclear, or outdated documentation.
title: "[Docs]: "
labels: ["type: documentation"]
assignees:
- nafasebra
body:
- type: markdown
attributes:
value: |
Thanks for helping us improve the documentation! Please describe what's missing or unclear.

- type: dropdown
id: doc_type
attributes:
label: Documentation Type
description: What type of documentation is this issue about?
options:
- README
- CLI help / man page
- Installation guide
- Contributing guide
- Other
validations:
required: true

- type: textarea
id: content
attributes:
label: What needs to be fixed?
description: A clear and concise description of what's missing, unclear, or outdated.
validations:
required: true

- type: textarea
id: location
attributes:
label: Location (if known)
description: Please provide a link or describe where the documentation needs to be updated.
placeholder: |
- In the README, under "Installation"
- https://github.com/nafasebra/tinypixels#-cli-usage
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nafasebra/tinypixels/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: 💡 Feature Request
description: Suggest an idea for this project.
title: "[Feature]: "
labels: ["type: enhancement"]
assignees:
- nafasebra
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature! Please describe the problem and solution as clearly as you can.

- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
placeholder: Ex. I'm always frustrated when [...]
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false

- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nafasebra/tinypixels/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
Loading