issue templates

This commit is contained in:
Sefik Ilkin Serengil 2024-04-20 20:51:46 +01:00
parent 5518a5d4f5
commit bec11b7a76
4 changed files with 124 additions and 0 deletions

View File

@ -0,0 +1,76 @@
name: '🐛 Report a bug'
description: 'Template for reporting bugs in the DeepFace project.'
title: [BUG]:
labels:
- bug
body:
- type: input
id: deepface-version
attributes:
label: DeepFace's version
description: |
Please provide your deepface version with calling `DeepFace.__version__` in your python program
placeholder: v0.0.X
validations:
required: true
- type: input
id: python-version
attributes:
label: Python version
description: |
Please provide your python programming language's version with calling `python --version` in your terminal
placeholder: 3.8.5
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: |
Please provide your operation system's details
placeholder: e.g. Windows 10 or Ubuntu 20.04
validations:
required: false
- type: textarea
id: dependencies
attributes:
label: Dependencies
description: |
Please provide python dependencies with calling `pip freeze`, in particular tensorflow's and keras' versions
validations:
required: true
- type: textarea
id: repro-code
attributes:
label: Repro Code
description: A ***minimal*** code sample which reproduces the issue
render: Python
validations:
required: true
- type: textarea
id: exception-message
attributes:
label: Exception Message
description: Please share the exception message from your terminal if your program is failing
validations:
required: false
- type: textarea
id: expected
attributes:
label: Expected Result
description: What did you expect to happen?
validations:
required: false
- type: textarea
id: actual
attributes:
label: What happened instead?
description: What actually happened?
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Info
description: |
Any additional info you'd like to provide.

View File

@ -0,0 +1,18 @@
name: '✨ Request a New Feature'
description: 'Propose a new feature'
title: '[FEATURE]: '
labels:
- 'enhancement'
body:
- type: textarea
id: description
attributes:
label: Description
description: Explain what your proposed feature would do and why this is useful.
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Info
description: Any additional info you'd like to provide.

View File

@ -0,0 +1,25 @@
name: '📝 Documentation'
description: 'Adding or improving in docs'
title: '[DOC]: '
labels:
- documentation
body:
- type: checkboxes
id: preliminary-checks
attributes:
label: Before You File a Documentation Request Please Confirm You Have Done The Following...
options:
- label: I have looked for existing [open or closed documentation requests](https://github.com/typescript-eslint/typescript-eslint/issues?q=is%3Aissue+label%3Adocumentation) that match my proposal.
required: true
- label: I have [read the FAQ](https://typescript-eslint.io/linting/troubleshooting) and my problem is not listed.
required: true
- type: markdown
attributes:
value: |
If your request is for help, not documentation, please ask on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript-eslint)
- type: textarea
attributes:
label: Suggested Changes
description: What would you like to see happen in the docs?
validations:
required: true

5
.github/ISSUE_TEMPLATE/config.yaml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question on StackOverflow
about: If you just want to ask a question, consider asking it on StackOverflow!
url: https://stackoverflow.com/questions/tagged/deepface