-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1472 from AgoraIO/issue-template-noblank
Issue Template Updates
- Loading branch information
Showing
6 changed files
with
155 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Docs update issue | ||
about: Request an update to a doc | ||
title: '' | ||
labels: 'Bug' | ||
assignees: saudsami, atovpeko | ||
|
||
--- | ||
|
||
**SDK/Product** | ||
|
||
<!-- Signaling, Broadcast Streaming, Voice... --> | ||
|
||
**Business case**: | ||
<!-- How will this issue help Agora customers or yourself? --> | ||
|
||
**Subject Matter Expert**: | ||
<!-- | ||
- *Technical*: @saudsami | ||
- *Language*: @atovpeko | ||
--> | ||
|
||
**Doc Link** | ||
<!-- Add links to any examples of the missing/incorrect docs, if applicable --> | ||
|
||
**Scope**: | ||
<!-- The products and documents to be updated. If you are not sure, leave it to @atovpeko. --> | ||
|
||
**Acceptance criteria**: | ||
|
||
- technically correct | ||
- easy to use | ||
- follows the template structure | ||
- follows the Google Developer Style Guide | ||
|
||
**Additional valuable information** | ||
|
||
<!-- Anything else that will help with this issue? (For example screenshots) --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: SDK bugs and feature requests. | ||
url: https://agora-ticket.agora.io/ | ||
about: Do you have a bug or feature request related to one of Agora's SDKs? |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
name: Docs update request | ||
description: Request an update or correction to documentation | ||
title: "[Bug]: " | ||
labels: 'Bug' | ||
assignees: saudsami, atovpeko | ||
|
||
body: | ||
- type: dropdown | ||
id: platform | ||
attributes: | ||
label: Platform | ||
description: Select the platform for the documentation update. | ||
options: | ||
- Android | ||
- iOS | ||
- Web | ||
- macOS | ||
- Windows | ||
- Electron | ||
- Unity | ||
- Flutter | ||
- React Native | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: product | ||
attributes: | ||
label: Product | ||
description: Select the product for the documentation update. | ||
options: | ||
- Video Calling | ||
- Interactive Live Streaming | ||
- Voice Calling | ||
- Broadcast Streaming | ||
- Chat | ||
- Signaling | ||
- Interactive Whiteboard | ||
- IoT SDK | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: other_product | ||
attributes: | ||
label: Other Product | ||
description: Enter the name of the product if you selected "Other" in the previous dropdown. | ||
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. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: subject_matter_expert | ||
attributes: | ||
label: Subject Matter Expert | ||
placeholder: | | ||
Technical: @saudsami | ||
Language: @atovpeko | ||
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. | ||
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. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: acceptance_criteria | ||
attributes: | ||
label: Acceptance Criteria | ||
placeholder: | | ||
- The documentation update must be technically accurate. | ||
- 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. | ||
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. | ||
validations: | ||
required: false |
6 changes: 4 additions & 2 deletions
6
.github/ISSUE_TEMPLATE/rewrite-a-document-according-to-the-new-architecture.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters