Skip to content

Commit

Permalink
fix yaml formatting of issue forms
Browse files Browse the repository at this point in the history
  • Loading branch information
maxxfrazer committed Sep 26, 2023
1 parent f486f71 commit ff9baa4
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions .github/ISSUE_TEMPLATE/new-issue.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Docs Update Request
about: Request an update or correction to documentation
title: ''
name: Docs update request
description: Request an update or correction to documentation
title: "[Bug]: "
labels: 'Bug'
assignees: saudsami, atovpeko

Expand All @@ -10,7 +10,7 @@ body:
attributes:
label: Platform
description: Select the platform for the documentation update.
choices:
options:
- Android
- iOS
- Web
Expand All @@ -21,14 +21,15 @@ body:
- Flutter
- React Native
- Other
required: true
validations:
required: true

- type: dropdown
id: product
attributes:
label: Product
description: Select the product for the documentation update.
choices:
options:
- Video Calling
- Interactive Live Streaming
- Voice Calling
Expand All @@ -38,21 +39,24 @@ body:
- Interactive Whiteboard
- IoT SDK
- Other
required: true
validations:
required: true

- type: text
- type: textarea
id: other_product
attributes:
label: Other Product
description: Enter the name of the product if you selected "Other" in the previous dropdown.
required: false
validations:
required: false

- type: textarea
id: business_case
attributes:
label: Business Case
description: Explain how addressing this documentation issue will benefit Agora customers or yourself.
required: true
validations:
required: true

- type: textarea
id: subject_matter_expert
Expand All @@ -61,21 +65,24 @@ body:
placeholder: |
Technical: @saudsami
Language: @atovpeko
required: false
validations:
required: false

- type: textarea
id: documentation_link
attributes:
label: Documentation Link
description: Provide links to the relevant documentation that needs an update or correction.
required: true
validations:
required: true

- type: textarea
id: scope
attributes:
label: Scope
description: Indicate the products and documents that should be updated. If unsure, leave it to @atovpeko to decide.
required: false
validations:
required: false

- type: textarea
id: acceptance_criteria
Expand All @@ -86,11 +93,13 @@ body:
- It should be easy for users to follow and understand.
- It should adhere to the template structure.
- It should follow the Google Developer Style Guide.
required: true
validations:
required: true

- type: textarea
id: additional_information
attributes:
label: Additional Information
description: Include any additional details, such as screenshots or context, that will help in addressing this documentation issue.
required: false
validations:
required: false

0 comments on commit ff9baa4

Please sign in to comment.