Skip to content

Distribute and run LLMs with a single file.

github: add issue templates (#442)

Brian076dfb0dae21
diff --git a/.github/ISSUE_TEMPLATE/bug-critical.yml b/.github/ISSUE_TEMPLATE/bug-critical.yml
new file mode 100644
index 00000000..3b50a355
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-critical.yml
@@ -0,0 +1,58 @@
+name: Critical Severity Bug
+about: Used to report critical severity bugs in llamafiles (e.g. Crashing, Corrupted, Dataloss)
+title: "Bug: "
+labels: ["bug", "critical severity"]
+assignees: ''
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ Please include information about your system, the steps to reproduce the bug,
+ and the version of llamafiles that you are using.
+ If possible, please provide a minimal code example that reproduces the bug.
+ - type: input
+ id: contact
+ attributes:
+ label: Contact Details
+ description: How can we get in touch with you if we need more info?
+ placeholder: ex. [email protected]
+ validations:
+ required: false
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: Also tell us, what did you expect to happen?
+ placeholder: Tell us what you see!
+ validations:
+ required: true
+ - type: textarea
+ id: version
+ attributes:
+ label: Version
+ description: What version of our software are you running? (use `--version` to get a version string)
+ placeholder: "llamafile v0.8.4"
+ validations:
+ required: true
+ - type: dropdown
+ id: operating-system
+ attributes:
+ label: What operating system are you seeing the problem on?
+ multiple: true
+ options:
+ - Linux
+ - Mac
+ - Windows
+ - FreeBSD
+ - OpenBSD
+ - NetBSD
+ - BIOS
+ validations:
+ required: false
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ render: shell
diff --git a/.github/ISSUE_TEMPLATE/bug-high.yml b/.github/ISSUE_TEMPLATE/bug-high.yml
new file mode 100644
index 00000000..3d519e56
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-high.yml
@@ -0,0 +1,58 @@
+name: High Severity Bug
+about: Used to report high severity bugs in llamafiles (e.g. Malfunctioning features hindering important common workflow)
+title: "Bug: "
+labels: ["bug", "high severity"]
+assignees: ''
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ Please include information about your system, the steps to reproduce the bug,
+ and the version of llamafiles that you are using.
+ If possible, please provide a minimal code example that reproduces the bug.
+ - type: input
+ id: contact
+ attributes:
+ label: Contact Details
+ description: How can we get in touch with you if we need more info?
+ placeholder: ex. [email protected]
+ validations:
+ required: false
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: Also tell us, what did you expect to happen?
+ placeholder: Tell us what you see!
+ validations:
+ required: true
+ - type: textarea
+ id: version
+ attributes:
+ label: Version
+ description: What version of our software are you running? (use `--version` to get a version string)
+ placeholder: "llamafile v0.8.4"
+ validations:
+ required: true
+ - type: dropdown
+ id: operating-system
+ attributes:
+ label: What operating system are you seeing the problem on?
+ multiple: true
+ options:
+ - Linux
+ - Mac
+ - Windows
+ - FreeBSD
+ - OpenBSD
+ - NetBSD
+ - BIOS
+ validations:
+ required: false
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ render: shell
diff --git a/.github/ISSUE_TEMPLATE/bug-low.yml b/.github/ISSUE_TEMPLATE/bug-low.yml
new file mode 100644
index 00000000..307cd74c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-low.yml
@@ -0,0 +1,58 @@
+name: Low Severity Bugs
+about: Used to report low severity bugs in llamafiles (e.g. cosmetic issues, non critical UI glitches)
+title: "Bug: "
+labels: ["bug", "low severity"]
+assignees: ''
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ Please include information about your system, the steps to reproduce the bug,
+ and the version of llamafiles that you are using.
+ If possible, please provide a minimal code example that reproduces the bug.
+ - type: input
+ id: contact
+ attributes:
+ label: Contact Details
+ description: How can we get in touch with you if we need more info?
+ placeholder: ex. [email protected]
+ validations:
+ required: false
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: Also tell us, what did you expect to happen?
+ placeholder: Tell us what you see!
+ validations:
+ required: true
+ - type: textarea
+ id: version
+ attributes:
+ label: Version
+ description: What version of our software are you running? (use `--version` to get a version string)
+ placeholder: "llamafile v0.8.4"
+ validations:
+ required: true
+ - type: dropdown
+ id: operating-system
+ attributes:
+ label: What operating system are you seeing the problem on?
+ multiple: true
+ options:
+ - Linux
+ - Mac
+ - Windows
+ - FreeBSD
+ - OpenBSD
+ - NetBSD
+ - BIOS
+ validations:
+ required: false
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ render: shell
diff --git a/.github/ISSUE_TEMPLATE/bug-medium.yml b/.github/ISSUE_TEMPLATE/bug-medium.yml
new file mode 100644
index 00000000..c86faa78
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-medium.yml
@@ -0,0 +1,58 @@
+name: Medium Severity Bug
+about: Used to report medium severity bugs in llamafiles (e.g. Malfunctioning Features but generally still useable)
+title: "Bug: "
+labels: ["bug", "medium severity"]
+assignees: ''
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ Please include information about your system, the steps to reproduce the bug,
+ and the version of llamafiles that you are using.
+ If possible, please provide a minimal code example that reproduces the bug.
+ - type: input
+ id: contact
+ attributes:
+ label: Contact Details
+ description: How can we get in touch with you if we need more info?
+ placeholder: ex. [email protected]
+ validations:
+ required: false
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: Also tell us, what did you expect to happen?
+ placeholder: Tell us what you see!
+ validations:
+ required: true
+ - type: textarea
+ id: version
+ attributes:
+ label: Version
+ description: What version of our software are you running? (use `--version` to get a version string)
+ placeholder: "llamafile v0.8.4"
+ validations:
+ required: true
+ - type: dropdown
+ id: operating-system
+ attributes:
+ label: What operating system are you seeing the problem on?
+ multiple: true
+ options:
+ - Linux
+ - Mac
+ - Windows
+ - FreeBSD
+ - OpenBSD
+ - NetBSD
+ - BIOS
+ validations:
+ required: false
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ render: shell
diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml
new file mode 100644
index 00000000..395e11de
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement.yml
@@ -0,0 +1,52 @@
+name: Enhancement template
+about: Used to request enhancements for llamafiles
+title: "Feature Request: "
+labels: ["enhancement"]
+assignees: ''
+body:
+ - type: markdown
+ attributes:
+ value: |
+ [Please post your idea first in Discussion if there is not yet a consensus for this enhancement request. This will help to keep this issue tracker focused on enhancements that the community has agreed needs to be implemented.](https://github.com/Mozilla-Ocho/llamafile/discussions/categories/ideas)
+
+ - type: checkboxes
+ id: prerequisites
+ attributes:
+ label: Prerequisites
+ description: Please confirm the following before submitting your enhancement request.
+ options:
+ - label: I am running the latest code. Mention the version if possible as well.
+ required: true
+ - label: I carefully followed the [README.md](https://github.com/Mozilla-Ocho/llamafile/blob/master/README.md).
+ required: true
+ - label: I searched using keywords relevant to my issue to make sure that I am creating a new issue that is not already open (or closed).
+ required: true
+ - label: I reviewed the [Discussions](https://github.com/Mozilla-Ocho/llamafile/discussions), and have a new and useful enhancement to share.
+ required: true
+
+ - type: textarea
+ id: feature-description
+ attributes:
+ label: Feature Description
+ description: Please provide a detailed written description of what you were trying to do, and what you expected `llamafiles` to do as an enhancement.
+ placeholder: Detailed description of the enhancement
+ validations:
+ required: true
+
+ - type: textarea
+ id: motivation
+ attributes:
+ label: Motivation
+ description: Please provide a detailed written description of reasons why this feature is necessary and how it is useful to `llamafiles` users.
+ placeholder: Explanation of why this feature is needed and its benefits
+ validations:
+ required: true
+
+ - type: textarea
+ id: possible-implementation
+ attributes:
+ label: Possible Implementation
+ description: If you have an idea as to how it can be implemented, please write a detailed description. Feel free to give links to external sources or share visuals that might be helpful to understand the details better.
+ placeholder: Detailed description of potential implementation
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
new file mode 100644
index 00000000..b3d6ce09
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,39 @@
+name: Question template
+about: Used to ask questions about llamafiles
+title: "Question: "
+labels: ["question"]
+assignees: ''
+body:
+ - type: markdown
+ attributes:
+ value: |
+ [Please search your question first in Discussion if you got a common general question.](https://github.com/Mozilla-Ocho/llamafile/discussions/categories/q-a)
+
+ - type: checkboxes
+ id: prerequisites
+ attributes:
+ label: Prerequisites
+ description: Please confirm the following before submitting your question.
+ options:
+ - label: I searched using keywords relevant to my issue to make sure that I am creating a new issue that is not already open (or closed).
+ required: true
+ - label: I reviewed the [Discussions](https://github.com/Mozilla-Ocho/llamafile/discussions), and have a new useful question to share that cannot be answered within Discussions.
+ required: true
+
+ - type: textarea
+ id: background-description
+ attributes:
+ label: Background Description
+ description: Please provide a detailed written description of what you were trying to do, and what you expected `llamafiles` to do as an question.
+ placeholder: Detailed description of your question
+ validations:
+ required: true
+
+ - type: textarea
+ id: possible-answer
+ attributes:
+ label: Possible Answer
+ description: If you have some idea of possible answers you want to confirm, that would also be appreciated.
+ placeholder: Your idea of possible answers
+ validations:
+ required: false