|
1 | 1 | --- |
2 | 2 | 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. |
4 | 4 | title: "Tracking Issue: " |
5 | 5 | labels: tracking-issue |
6 | 6 | --- |
7 | 7 |
|
8 | 8 | <!-- |
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. |
12 | 12 |
|
13 | 13 | Route discussion elsewhere: |
14 | 14 |
|
15 | | -- New ideas, fit questions, or early design feedback: start with a GitHub |
16 | | - Discussion. |
17 | 15 | - Bug reports surfaced while implementing: file a bug issue and reference this |
18 | 16 | tracking issue. |
19 | 17 | - A design thread big enough to need its own page: spawn a tracking issue (as |
20 | 18 | a sub-issue of this one if it is narrow) and discuss it there. |
21 | 19 |
|
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. |
24 | 21 | --> |
25 | 22 |
|
26 | 23 | This is a tracking issue for ... |
27 | 24 |
|
28 | 25 | <!-- |
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. |
32 | 44 | --> |
33 | 45 |
|
34 | 46 | ## Design |
|
0 commit comments