Skip to content

Commit 73e18fe

Browse files
committed
Add templates for main issue types
Fix #1741
1 parent 9589ed7 commit 73e18fe

File tree

4 files changed

+107
-8
lines changed

4 files changed

+107
-8
lines changed

.github/ISSUE_TEMPLATE/document.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Write or Update
3+
about: Write or update a documentation page
4+
title: "[0pt] {feature name}"
5+
labels:
6+
assignees:
7+
---
8+
# Feature name
9+
10+
Fill in whatever you know at the moment.
11+
12+
**Product:** Tarantool, Cartridge, TDG, connectors, tools?
13+
**Since:** product version
14+
**Audience/target:** who will read it and for what task?
15+
**Root document:** where to add or update documentation
16+
**SME:** @ expert to ask for more information
17+
**Peer reviewer:** @ documentarian name
18+
19+
# Details
20+
21+
* What should we write about?
22+
* What's most important?
23+
* Examples of code and configuration.
24+
* Related development issues and/or commits.
25+
26+
# DoD
27+
28+
- [ ] do A
29+
- [ ] do B
30+
31+
# Planning checklist
32+
33+
- [ ] Pick product label:
34+
- [server](https://github.com/tarantool/doc/labels/server) for Tarantool core
35+
- [cartridge](https://github.com/tarantool/doc/labels/cartridge),
36+
- [tdg](https://github.com/tarantool/doc/labels/tdg), or
37+
- [ecosystem](https://github.com/tarantool/doc/labels/ecosystem)
38+
for tools and connectors.
39+
- [ ] Pick type label:
40+
- [reference](https://github.com/tarantool/doc/labels/reference),
41+
- [getting started](https://github.com/tarantool/doc/labels/getting%20started),
42+
- [user_guide](https://github.com/tarantool/doc/labels/user_guide), etc.
43+
- [ ] Estimate complexity in storypoints in the title
44+
- [ ] Add to **Documentation** board → **Backlog**
45+
46+
> Note: issue templates are in beta. Give your feedback in #1869.

.github/ISSUE_TEMPLATE/fix.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Fix & Proofread
3+
about: Fix typos, proofread document
4+
title: "[0pt] Typo {document name}"
5+
labels: typo
6+
assignees:
7+
---
8+
9+
## Info
10+
11+
**Root document:** where to fix the docs
12+
13+
## What's wrong?
14+
15+
Please give details or examples.
16+
17+
## Planning checklist
18+
19+
- [ ] Estimate complexity in storypoints in the title.
20+
- [ ] Add to **Documentation** board → **Backlog (small)**
21+
22+
> Note: issue templates are in beta. Give your feedback in #1869.

.github/ISSUE_TEMPLATE/tech.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Technical/internal issue
3+
about: Technical debt in the docs
4+
title: "[0pt] {do X}"
5+
labels:
6+
assignees:
7+
---
8+
# What needs to be done
9+
10+
**Reviewer:** @ documentarian name
11+
12+
# DoD
13+
14+
- [ ] do A
15+
- [ ] do B
16+
17+
# Planning checklist
18+
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.
23+
- [ ] Estimate complexity in storypoints in the title
24+
- [ ] Add to **Documentation** board → **Backlog**
25+
26+
> Note: issue templates are in beta. Give your feedback in #1869.

.github/ISSUE_TEMPLATE/translate.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
---
22
name: Translate
33
about: Translation issue
4-
title: "[0sp] Translate"
4+
title: "[0pt] Translate {document_title}"
55
labels: localization
66
assignees: ladyune
77

88
---
9+
## Info
910

10-
Page: link to website
11-
Crowdin: link to file in Crowdin
12-
Words: amount of words to translate, see in Crowdin
13-
Reviewer: author of the document or subject matter expert
11+
**Page:** link to website
12+
**Crowdin:** link to file in Crowdin
13+
**Words:** amount of words to translate, see in Crowdin
14+
**Reviewer:** author of the document or subject matter expert
1415

15-
- [ ] Add to Localization board → Ready for review
16-
- [ ] Evaluate *review* in storypoints in the title
17-
- [ ] Add to Docs board → Backlog, so that we can plan it
16+
## Issue planning checklist
17+
18+
- [ ] Estimate *review* in storypoints in the title
19+
- [ ] Add to **Localization** board → **Ready for review**
20+
- [ ] Add to **Documentation** board → **Backlog**
21+
22+
> Note: issue templates are in beta. Give your feedback in #1869.

0 commit comments

Comments
 (0)