Skip to content

Commit

Permalink
Merge pull request #256 from chroma-core/swyx/add-issue-templates
Browse files Browse the repository at this point in the history
  • Loading branch information
swyxio authored Apr 13, 2023
2 parents 63ba3f8 + 51d670f commit d56dc3c
Show file tree
Hide file tree
Showing 3 changed files with 148 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug Report
description: File a bug report with Chroma
title: "[Bug]: "
labels: ["bug", "triage"]
# assignees:
# - octocat
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- 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!
# value: "A bug happened!"
validations:
required: true
# - type: dropdown
# id: version
# attributes:
# label: Version
# description: What version of Chroma are you running?
# options:
# - 1.0.2 (Default)
# - 1.0.3 (Edge)
# validations:
# required: true
- type: textarea
id: versions
attributes:
label: Versions
description: We need your Chroma, Python, and OS versions, as well as whatever else you think relevant.
placeholder: Chroma v0.3.14, Python 3.9.6, MacOS 12.5
# value: "A bug happened!"
validations:
required: true
- 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
# - type: checkboxes
# id: terms
# attributes:
# label: Code of Conduct
# description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
# options:
# - label: I agree to follow this project's Code of Conduct
# required: true
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: "Feature Request"
description: Suggest an idea for Chroma
title: "[Feature Request]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request this feature!
- type: textarea
id: problem
attributes:
label: Describe the problem
description: Please provide a clear and concise description the problem this feature would solve. The more information you can provide here, the better.
placeholder: I prefer if...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the proposed solution
description: Please provide a clear and concise description of what you would like to happen.
placeholder: I would like to see...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: "Please provide a clear and concise description of any alternative solutions or features you've considered."
- type: dropdown
id: importance
attributes:
label: Importance
description: How important is this feature to you?
options:
- nice to have
- would make my life easier
- i cannot use Chroma without it
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Information
description: Add any other context or screenshots about the feature request here.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/installation_trouble.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Installation Issue
description: Request for install help with Chroma
title: "[Install issue]: "
labels: ["installation trouble"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this issue report!
- 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!
# value: "A bug happened!"
validations:
required: true
- type: textarea
id: versions
attributes:
label: Versions
description: We need your Chroma, Python, and OS versions, as well as whatever else you think relevant.
placeholder: Chroma v0.3.14, Python 3.9.6, MacOS 12.5
# value: "A bug happened!"
validations:
required: true
- 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
# - type: checkboxes
# id: terms
# attributes:
# label: Code of Conduct
# description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
# options:
# - label: I agree to follow this project's Code of Conduct
# required: true

0 comments on commit d56dc3c

Please sign in to comment.