Skip to content

Commit 6a4065b

Browse files
feat: update doc-related issue templates to use consistent labels and types (#394)
Co-authored-by: Antonio <bandantonio@users.noreply.github.com> Co-authored-by: Ashish Padhy <ashishpadhy1729@gmail.com>
1 parent ae10121 commit 6a4065b

2 files changed

Lines changed: 11 additions & 13 deletions

File tree

.github/ISSUE_TEMPLATE/docs-bug.yml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1-
name: Docs Bug 🐞 report
1+
name: 📑🐞 Docs Bug
22
description: Report mistakes and/or bugs in AsyncAPI Docs.
3-
title: "[Docs Bug 🐞 report]: "
4-
labels: "🐞 docs bug"
5-
assignees: alequetzalli
6-
-
3+
labels: "📑 docs"
4+
title: "[📑🐞 Docs Bug]: "
5+
type: Bug
76
body:
87
- type: markdown
98
attributes:
109
value: |
1110
Thank you for reporting mistakes and/or bugs 🐞 in AsyncAPI Docs 📑. We appreciate your contribution! 🙂
1211
13-
Before filing this `Docs Bug` report, please make sure to check if someone already filed this bug report in our [Dev Docs Board](https://github.com/orgs/asyncapi/projects/8).
12+
Before proceeding, please make sure to check if someone already filed the same bug report in our [Dev Docs Board](https://github.com/orgs/asyncapi/projects/8).
1413
- type: textarea
1514
id: describe-bug
1615
attributes:
1716
label: Describe the bug you found in AsyncAPI Docs.
1817
description: Is there a bug in one of our code snippets? Did we explain a concept incorrectly? Please share a clear and concise description of what the bug or mistake is.
19-
placeholder: "I would like to file an AsyncAPI Docs Bug 🐞 report about..."
18+
placeholder: "I would like to file an AsyncAPI 📑🐞 Docs Bug report about..."
2019
validations:
2120
required: true
2221
- type: textarea
@@ -37,7 +36,7 @@ body:
3736
required: true
3837
- type: dropdown
3938
attributes:
40-
label: Are you willing to work on this issue ?
39+
label: Are you willing to work on this issue?
4140
description: This is absolutely not required, but we are happy to guide you in the contribution process.
4241
options:
4342
- "Yes I am willing to submit a PR!"

.github/ISSUE_TEMPLATE/docs.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,21 @@ name: 📑 Docs
22
description: Propose changes and improvements to AsyncAPI Docs.
33
labels: "📑 docs"
44
title: "[📑 Docs]: "
5-
assignees: alequetzalli
6-
-
5+
type: Feature
76
body:
87
- type: markdown
98
attributes:
109
value: |
1110
Thank you for contributing to AsyncAPI Docs! 📑 👩🏻‍💻 We appreciate your feedback, ideas, and contributions.
1211
13-
Before filing this issue, please make sure to check if there's already a similar issue open in our [Dev Docs Board](https://github.com/orgs/asyncapi/projects/8).
12+
Before proceeding, please make sure to check if there's already a similar issue open in our [Dev Docs Board](https://github.com/orgs/asyncapi/projects/8).
1413
1514
- type: textarea
1615
id: reason-context
1716
attributes:
1817
label: What Dev Docs changes are you proposing?
1918
description: Why do the Docs need this improvement? What is the motivation for this change? How will this change benefit our Open-Source community?
20-
placeholder: "I would like to contribute to AsyncAPI Docs 📑 by..."
19+
placeholder: "I would like to contribute to AsyncAPI 📑 Docs by..."
2120
validations:
2221
required: true
2322
- type: checkboxes
@@ -30,7 +29,7 @@ body:
3029
required: true
3130
- type: dropdown
3231
attributes:
33-
label: Are you willing to work on this issue ?
32+
label: Are you willing to work on this issue?
3433
description: This is absolutely not required, but we are happy to guide you in the contribution process.
3534
options:
3635
- "Yes I am willing to submit a PR!"

0 commit comments

Comments
 (0)