Skip to content

Commit ab175d2

Browse files
authored
Make issue templates more convenient (#2596)
* Add epic templates * Remove unused information * Add dev.issue line for regular issues
1 parent 2510f58 commit ab175d2

File tree

6 files changed

+39
-14
lines changed

6 files changed

+39
-14
lines changed

.github/ISSUE_TEMPLATE/document.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
---
2-
name: Write or Update
2+
name: Write or update
33
about: Write or update a documentation page
44
title: "[0pt] {feature_name}"
55
labels:
66
assignees:
77
---
8-
# Feature name
9-
10-
Fill in whatever you know at the moment.
8+
**Related dev. issue(s):** GitHub link(s)
119

1210
**Product:** Tarantool, Cartridge, TDG, connectors, tools?
1311
**Since:** product version
1412
**Audience/target:** who will read it and for what task?
1513
**Root document:** where to add or update documentation
1614
**SME:** @ expert to ask for more information
17-
**Peer reviewer:** @ documentarian name
1815

1916
# Details
2017

@@ -43,4 +40,4 @@ Fill in whatever you know at the moment.
4340
- [ ] Estimate complexity in storypoints in the title
4441
- [ ] Add to **Documentation** board → **Backlog**
4542

46-
> Note: issue templates are in beta. Give your feedback in #1869.
43+
> Note: issue templates are in beta. Give your feedback in #1869.

.github/ISSUE_TEMPLATE/epic.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Epic
3+
about: Create an umbrella ticket for future release documentation
4+
title: "[Epic] {epic_name}"
5+
labels: epic
6+
assignees:
7+
---
8+
**Related dev. epic:** GitHub link
9+
**PM ref.:** Notion link
10+
**SME:** @ expert to ask for more information
11+
12+
# Details
13+
14+
- [ ] GitHub issue
15+
- [ ] GitHub issue
16+
17+
Provide any details you consider necessary.

.github/ISSUE_TEMPLATE/fix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Fix & Proofread
2+
name: Fix & proofread
33
about: Fix typos, proofread document
44
title: "[0pt] Fix {document_title}"
55
labels: typo

.github/ISSUE_TEMPLATE/tech.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Technical/internal issue
3-
about: Technical debt in the docs
3+
about: Technical issue in the docs
44
title: "[0pt] {do X}"
55
labels: internal
66
assignees:
@@ -16,11 +16,8 @@ assignees:
1616

1717
# Planning checklist
1818

19-
- [ ] Pick label:
20-
- [CI/CD](https://github.com/tarantool/doc/labels/CI/CD)
21-
- [localization](https://github.com/tarantool/doc/labels/localization)
22-
- or others.
19+
- [ ] Pick a label
2320
- [ ] Estimate complexity in storypoints in the title
2421
- [ ] Add to **Documentation** board → **Backlog**
2522

26-
> Note: issue templates are in beta. Give your feedback in #1869.
23+
> Note: issue templates are in beta. Give your feedback in #1869.
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Technical debt epic
3+
about: Umbrella ticket for technical debt in the docs
4+
title: "[Tech debt] {epic_name}"
5+
labels: epic
6+
assignees:
7+
---
8+
9+
# Details
10+
11+
- [ ] GitHub issue
12+
- [ ] GitHub issue
13+
14+
Provide any details you consider necessary.

.github/ISSUE_TEMPLATE/translate.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Translate
33
about: Translation issue
44
title: "[0pt] Translate {document_title}"
55
labels: localization
6-
assignees: ladyune
6+
assignees:
77

88
---
99
## Info

0 commit comments

Comments
 (0)