Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

Commit

Permalink
Adds Issue/bug template
Browse files Browse the repository at this point in the history
This adds a template for bug/issue report.
  • Loading branch information
pandora-s-git authored Jun 10, 2024
1 parent 5efba3b commit 2d534fb
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_client.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Bug report related to the JS client
description: Submit a bug report that's related to the JS client
title: '[BUG CLIENT]: '
labels: ['bug client', 'triage']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: node-v
attributes:
label: Node -v
description: Run `node -v`
placeholder: Copy-paste the output (no need for backticks, will be formatted into code automatically)
render: shell
validations:
required: true
- type: textarea
id: npm-ls
attributes:
label: NPM ls
description: Run `npm ls --depth=0`
placeholder: Copy-paste the output (no need for backticks, will be formatted into code automatically)
render: shell
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Reproduction Steps
description: Provide a clear and concise description of the steps that lead to your issue.
placeholder: |
1. First step...
2. Step 2...
...
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Explain briefly what you expected to happen.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any context about your problem that you deem relevant.
- type: textarea
id: suggested-solutions
attributes:
label: Suggested Solutions
description: Please list any solutions you recommend we consider.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_model.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Bug report related to our models
description: Submit a bug report that's related to our models behavior
title: '[BUG MODEL]: '
labels: ['bug model', 'triage']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
id: model
attributes:
label: Model
description: What's the model?
options:
- open-mistral-7b
- open-mixtral-8x7b
- open-mixtral-8x22b
- mistral-small-latest
- mistral-medium-latest
- mistral-large-latest
- mistral-embed
- codestral-latest
default: 0
validations:
required: true
- type: textarea
id: model-payload
attributes:
label: Request Payload
description: Please provide the full request payload.
placeholder: If possible, if not provide as much information as you can such as "messages", "max_tokens", "temperature", "prefix", "tool_calls" and all kinds of information.
validations:
required: true
- type: textarea
id: model-output
attributes:
label: Output
description: Provide the output of the model.
validations:
required: true
- type: textarea
id: model-expected-output
attributes:
label: Expected Behavior
description: Explain briefly what you expected to happen.
validations:
required: true
- type: textarea
id: model-additional-context
attributes:
label: Additional Context
description: Add any context about your problem that you deem relevant.
- type: textarea
id: model-suggested-solutions
attributes:
label: Suggested Solutions
description: Please list any solutions you recommend we consider.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://docs.mistral.ai
about: Developer documentation for the Mistral AI platform
- name: Discord
url: https://discord.com/invite/mistralai)
about: Chat with the Mistral community

0 comments on commit 2d534fb

Please sign in to comment.