Skip to content

Commit b13ba9c

Browse files
authored
Improve the issue templates (#7700)
## Summary Now that I've written a few of these, I think these are some helpful adjustments to the templates. ## Testing N/A Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
1 parent ac8c751 commit b13ba9c

2 files changed

Lines changed: 35 additions & 23 deletions

File tree

.github/ISSUE_TEMPLATE/epic.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
---
22
name: Epic
3-
about: Public roadmap umbrella for a major Vortex initiative.
3+
about: Umbrella issue for a major initiative tracked via sub-issues.
44
title: "Epic: "
55
labels: epic
66
---
77

88
<!--
9-
An Epic is a public roadmap umbrella for a major Vortex initiative. It should
10-
explain the goal, why it matters, what is out of scope, and where concrete work
11-
is tracked.
9+
An Epic is the umbrella for work that ships as several tracking issues. Attach
10+
them with GitHub's "Create sub-issue" or "Add existing sub-issue" button. The
11+
sub-issue panel tracks progress, so this issue does not need a checklist.
1212
13-
Attach related tracking issues with GitHub's "Create sub-issue" or "Add
14-
existing sub-issue" button. The sub-issue panel tracks progress, so this issue
15-
does not need a checklist.
16-
17-
Keep Epic issues readable. Route discussion elsewhere:
13+
Keep this issue readable. Route discussion elsewhere:
1814
1915
- Open-ended scope or product questions: open a GitHub Discussion and link it
2016
here.
@@ -28,8 +24,10 @@ Short clarifying comments are fine. Long threads should be redirected.
2824
This Epic is for ...
2925

3026
<!--
31-
One or two sentences. State the initiative and link any roadmap, design, or
32-
external context that helps readers understand the scope.
27+
One or two sentences explaining this Epic.
28+
29+
Please also link any roadmap, design, or external context that helps readers
30+
understand the scope.
3331
-->
3432

3533
## Status
@@ -38,10 +36,12 @@ external context that helps readers understand the scope.
3836
Proposed / Active / Blocked / Complete. Briefly explain the current state.
3937
-->
4038

39+
**Proposed.**
40+
4141
## Goal
4242

4343
<!--
44-
One short paragraph covering both:
44+
Cover both:
4545
4646
- What "done" looks like for a user or downstream consumer. Name the concrete
4747
API, format, encoding, or benchmark.

.github/ISSUE_TEMPLATE/tracking_issue.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,46 @@
11
---
22
name: Tracking Issue
3-
about: Implementation context for work likely to span multiple PRs.
3+
about: A tracking issue for a feature or initiative in Vortex.
44
title: "Tracking Issue: "
55
labels: tracking-issue
66
---
77

88
<!--
9-
Tracking issues are for work that needs shared implementation context and is
10-
likely to span multiple PRs. Use this template when the issue should track
11-
planning, implementation, stabilization, and follow-through.
9+
Thank you for opening a tracking issue. Tracking issues record a feature's
10+
progress from design to landing and connect related bugs, PRs, and design
11+
questions. They should stay readable a year from now.
1212
1313
Route discussion elsewhere:
1414
15-
- New ideas, fit questions, or early design feedback: start with a GitHub
16-
Discussion.
1715
- Bug reports surfaced while implementing: file a bug issue and reference this
1816
tracking issue.
1917
- A design thread big enough to need its own page: spawn a tracking issue (as
2018
a sub-issue of this one if it is narrow) and discuss it there.
2119
22-
Tracking issues should be understandable a year from creation. Short clarifying
23-
comments are fine. Long threads should be redirected.
20+
Short clarifying comments are fine. Long threads should be redirected.
2421
-->
2522

2623
This is a tracking issue for ...
2724

2825
<!--
29-
One or two sentences. State what the feature is and where it lives in the
30-
codebase (crate, module, file format, encoding). Link the parent Epic, design
31-
doc, prototype PR, or external reference.
26+
State what the feature is and where it lives in the codebase (crate, module,
27+
file format, encoding). Link the parent Epic, design doc, prototype PR, or
28+
external reference if any.
29+
-->
30+
31+
## Motivation
32+
33+
<!--
34+
Optional. Skip if this is a sub-issue of an Epic that already covers the why.
35+
36+
For standalone tracking issues, cover:
37+
38+
- The concrete problem and who hits it. Examples: a downstream integration
39+
(DataFusion, DuckDB, Python, Java), a benchmark gap (TPC-H, ClickBench,
40+
vortex-bench), a regression against Parquet or Arrow, or a file format or
41+
encoding limitation.
42+
- What is currently blocked, slower, or larger than it should be. Link the
43+
benchmark numbers, profile output, or related issues.
3244
-->
3345

3446
## Design

0 commit comments

Comments
 (0)