Skip to content

Commit 3cdd722

Browse files
committed
fixup! Add template for a proposal for a new optimization.
- Formatting improvements.
1 parent f937932 commit 3cdd722

File tree

1 file changed

+39
-30
lines changed

1 file changed

+39
-30
lines changed

.github/ISSUE_TEMPLATE/07-optimization.yml

Lines changed: 39 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,55 +7,64 @@
77
# the Business Source License, use of this software will be governed
88
# by the Apache License, Version 2.0.
99

10-
name: "Internal - Proposed Optimization"
10+
name: "Internal: proposed optimization"
1111
description: A proposal for a new query optimization. Contributor use only.
12-
labels: ["A-optimization", "needs-discussion"]
12+
labels: ["A-optimization", "C-feature", "needs-discussion"]
1313
body:
1414
- type: textarea
1515
attributes:
1616
label: Elevator pitch
17-
description: Each question should be answered comprehensively but using as
18-
few sentences as possible.
17+
description: |
18+
Each question should be answered comprehensively but using as few sentences as possible.
1919
value: |
20-
1. What does the transformation do? Give a representative SQL query.
21-
2. Why should we add it?
22-
3. When would it be good to have?
23-
4. When would it be ineffectual?
24-
5. When would be bad to have?
25-
6. In the worst case, how would it degrade performance?
20+
### What does the transformation do?
21+
<!-- Give a representative SQL query. -->
22+
23+
### Why should we add it?
24+
25+
### When would it be good to have?
26+
27+
### When would it be ineffectual?
28+
29+
### When would be bad to have?
30+
31+
### In the worst case, how would it degrade performance?
2632
validations:
2733
required: true
2834
- type: textarea
2935
attributes:
30-
label: List real life instances where this transformation would help.
36+
label: Customer impact
37+
description: |
38+
List real life instances where this transformation would help.
3139
- type: textarea
3240
attributes:
33-
label: Cost Model
41+
label: Cost model
3442
description: |
35-
If both the implementation and cost model are simple, this section can
36-
be skipped if the implementation section is filled in.
43+
If both the implementation and cost model are simple, this section can be skipped if the implementation section is filled in.
3744
38-
Each subsection is meant to be answered with formulae. Take into account
39-
memory, CPU, liveness, and skew. Approximations are ok if it is not
40-
possible to calculate exact numbers.
45+
Each subsection is meant to be answered with formulae. Take into account memory, CPU, liveness, and skew. Approximations are ok if it is not possible to calculate exact numbers.
4146
42-
If the transformation is always good to have, you only have to fill out
43-
the first subsection.
47+
If the transformation is always good to have, you only have to fill out the first subsection.
4448
value: |
45-
1. What is the benefit of the transformation?
46-
2. What is the overhead?
47-
3. When would the transformation be worthwhile? Intuitively, this should
48-
be when benefit > overhead, but sometimes a benefit with regards to X
49-
comes at a cost with regards to Y, and it would be worthwhile to discuss
50-
when it is worthwhile to sacrifice Y to gain a benefit in X.
49+
### What is the benefit of the transformation?
50+
51+
### What is the overhead?
52+
53+
### When would the transformation be worthwhile?
54+
<!-- Intuitively, this should be when benefit > overhead, but sometimes a benefit with regards to X comes at a cost with regards to Y, and it would be worthwhile to discuss when it is worthwhile to sacrifice Y to gain a benefit in X. -->
5155
- type: textarea
5256
attributes:
53-
label: List any knobs that we may need to tune or expose to the user.
57+
label: User-facing changes
58+
description: |
59+
List any knobs that we may need to be tuned by or exposed to the user.
5460
- type: textarea
5561
attributes:
5662
label: Proposed implementation
5763
value: |
58-
1. Describe the implementation.
59-
2. Which queries will do better with the given implementation?
60-
3. Which queries will do worse?
61-
4. Break the implementation down into stages.
64+
### Describe the implementation.
65+
66+
### Which queries will do better with the given implementation?
67+
68+
### Which queries will do worse?
69+
70+
### Break the implementation down into stages.

0 commit comments

Comments
 (0)