Skip to content

Commit

Permalink
chore: add issue templates (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
mhordynski authored Jul 23, 2024
1 parent 79a4458 commit 481f386
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/01_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: 🚀 Feature Request
description: Submit a proposal/request for a new ds-template feature.
title: "feat: <short_name>"
labels: ["feature"]
body:
- type: markdown
attributes:
value: |
Thanks for contributing to ds-template!
- type: textarea
id: feature-description
attributes:
label: Feature description
description: A clear and concise description of the feature proposal
placeholder: Tell us what you want!
validations:
required: true
- type: textarea
id: feature-motivation
attributes:
label: Motivation
description: A clear and concise description of what the problem is, e.g., I'm always frustrated when [...]
placeholder: Why do you need this feature?
validations:
required: true
- type: textarea
id: feature-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Screenshots, code snippets, etc.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/02_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: 🐞 Bug Report
description: File a bug report
title: "bug: <short_name>"
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: XYZ doesn't work as expected...
value: "A bug happened!"
validations:
required: true
- type: textarea
id : how-to-reproduce
attributes:
label: How can we reproduce it?
description: Please provide steps (commands) that led you to the bug.
placeholder: cookiecutter [email protected]:deepsense-ai/ds-template.git
render: bash
- 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

0 comments on commit 481f386

Please sign in to comment.