Skip to content

Make issue templates more convenient #2596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 25, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions .github/ISSUE_TEMPLATE/document.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
---
name: Write or Update
name: Write or update
about: Write or update a documentation page
title: "[0pt] {feature_name}"
labels:
assignees:
---
# Feature name

Fill in whatever you know at the moment.

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

# Details

Expand Down Expand Up @@ -43,4 +38,4 @@ Fill in whatever you know at the moment.
- [ ] Estimate complexity in storypoints in the title
- [ ] Add to **Documentation** board → **Backlog**

> Note: issue templates are in beta. Give your feedback in #1869.
> Note: issue templates are in beta. Give your feedback in #1869.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Epic
about: Create an umbrella ticket for future release documentation
title: "[Epic] {epic_name}"
labels:
assignees:
---
**Related dev. issue(s):** GitHub link(s)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Я бы этот пункт перенес в темплейт document.md, т.к. там есть чёткий маппинг на дев. задачу, чаще всего 1:1. Эпик может агрегировать много док. задач, и в итоге здесь может образоваться длинный список дев. задач, который мало чем поможет. Лучше здесь сделать ссылку на дев. эпик, как мы делали при планированиии Q1 (если такой дев. эпик существует, конечно же), тогда тоже будет маппинг 1:1.

**PM ref.:** Notion link
**SME:** @ expert to ask for more information

# Details

- [ ] GitHub issue
- [ ] GitHub issue

Provide any details you consider necessary.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/fix.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Fix & Proofread
name: Fix & proofread
about: Fix typos, proofread document
title: "[0pt] Fix {document_title}"
labels: typo
Expand Down
9 changes: 3 additions & 6 deletions .github/ISSUE_TEMPLATE/tech.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Technical/internal issue
about: Technical debt in the docs
about: Technical issue in the docs
title: "[0pt] {do X}"
labels: internal
assignees:
Expand All @@ -16,11 +16,8 @@ assignees:

# Planning checklist

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

> Note: issue templates are in beta. Give your feedback in #1869.
> Note: issue templates are in beta. Give your feedback in #1869.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/tech_debt_epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Technical debt epic
about: Umbrella ticket for technical debt in the docs
title: "[Tech debt] {epic_name}"
labels:
assignees:
---

# Details

- [ ] GitHub issue
- [ ] GitHub issue

Provide any details you consider necessary.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/translate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Translate
about: Translation issue
title: "[0pt] Translate {document_title}"
labels: localization
assignees: ladyune
assignees:

---
## Info
Expand Down