Skip to content

Commit

Permalink
docs: Create Use Case issue template (#324)
Browse files Browse the repository at this point in the history
* initial draft

* new line issue

* update link

* address comment

* add numbers
  • Loading branch information
dianzrong authored Jul 6, 2023
1 parent 755dd55 commit 20fb5a3
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/use_case.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Use Case
description: Describe a new use case for OpenAdapt
title: "Use Case: "
labels: usecase
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to add a new use case! Default text extracted from https://github.com/MLDSAI/OpenAdapt/issues/72#issuecomment-1601991759.
- type: input
id: role
attributes:
label: Role
description: Who is this use case about?
placeholder: Travel Agent
validations:
required: true
- type: textarea
id: task
attributes:
label: Task
description: What is this use case about?
placeholder: Book a flight
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: What background information is there?
placeholder: There are 4 people traveling to Barcelona, 2 of which require first class tickets
validations:
required: true
- type: textarea
id: workflow
attributes:
label: Workflow
description: How is the task accomplished? Please place each step on a new line.
placeholder: |
1. Open Chrome
2. Navigate to Google Flights
3. Set the departure city
4. ...
validations:
required: true

0 comments on commit 20fb5a3

Please sign in to comment.