Skip to content

Commit

Permalink
docs: add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
mishamyrt committed Jul 28, 2024
1 parent 3e8ab9a commit 3dab7eb
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: "Bug report πŸ›"
description: Report rendering issues or unexpected behavior
body:
- type: markdown
attributes:
value: |
Please make sure to [search for existing issues](https://github.com/mishamyrt/Lilex/issues) before filing a new one!
- type: input
id: version
attributes:
label: Lilex font version
placeholder: "2.530, 2.500"
validations:
required: true

- type: dropdown
id: format
attributes:
label: Font file format(s)
multiple: true
options:
- .ttf (variable)
- .ttf (static)
- I don't know
validations:
required: true

- type: input
id: platform
attributes:
label: Platform
placeholder: "macOS 14.5; Linux (freetype 2.13.2); Windows 11"
validations:
required: true

- type: textarea
id: software
attributes:
label: Other Software
description: If you're reporting a bug about Lilex's interaction with other software, what software? What versions?
placeholder: |
iTerm2
VS Code
Windows Terminal
validations:
required: false

- type: textarea
id: what-happened
attributes:
label: What happened?
placeholder: Tell us what's happening. Include some screenshots! Does it happen only at a certain font size or a certain pixel density?
validations:
required: true
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Feature Request/Idea πŸš€
about: Suggest a new feature or improvement (this does not mean you have to implement it)
title: "Feature Request"
labels: enhancement
assignees: ''

---

<!--
🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING:
1. If I delete this entire template and go my own path, maintainers may close my issue without further explanation or engagement.
2. If I list multiple bugs/concerns in this one issue, maintainers may close my issue without further explanation or engagement.
3. If I write an issue that has many duplicates, maintainers may close my issue without further explanation or engagement (and without necessarily spending time to find the exact duplicate ID number).
4. If I leave the title incomplete when filing the issue, maintainers may close my issue without further explanation or engagement.
5. If I file something completely blank in the body, maintainers may close my issue without further explanation or engagement.
All good? Then proceed!
-->

# Description of the new feature/enhancement (with images if possible)

<!--
A clear and concise description of what the problem is that the new feature would solve.
Describe why and how a user would use this new functionality (if applicable).
-->

# Proposed technical implementation details (optional)

<!--
A clear and concise description of what you want to happen.
-->

0 comments on commit 3dab7eb

Please sign in to comment.