Skip to content

Commit e30a384

Browse files
authored
Merge pull request #197 from joshtriplett/template-improvements
TEMPLATE.md: Distinguish between alignment on syntax and alignment on goal
2 parents 8628c92 + 41abd87 commit e30a384

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/TEMPLATE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
> Give it a title that describes what you plan to get done in the next 6 months
55
> (e.g., "stabilize X" or "nightly support for X" or "gather data about X").
66
> Feel free to replace any text with anything, but there are placeholders
7-
> designed to help you get started.
7+
> designed to help you get started.
88
>
99
> The **point of contact** is the person responsible for providing updates.
1010
>
@@ -39,6 +39,8 @@
3939
>
4040
> *This text is NORMATIVE, in the sense that teams should review this and make sure they are aligned. If not, then the shiny future should be moved to frequently asked questions with a title like "what might we do next".*
4141
42+
*However, for most proposals, alignment on exact syntax should not be required to start a goal, only alignment on the problem and the general sketch of the solution. This may vary for goals that are specifically about syntax, such as ergonomic improvements.*
43+
4244
## Design axioms
4345

4446
> *This section is optional, but including [design axioms][da] can help you signal how you intend to balance constraints and tradeoffs (e.g., "prefer ease of use over performance" or vice versa). Teams should review the axioms and make sure they agree. [Read more about design axioms][da].*
@@ -97,4 +99,4 @@ Definitions for terms used above:
9799

98100
### What do I do with this space?
99101

100-
*This is a good place to elaborate on your reasoning above -- for example, why did you put the design axioms in the order that you did? It's also a good place to put the answers to any questions that come up during discussion. The expectation is that this FAQ section will grow as the goal is discussed and eventually should contain a complete summary of the points raised along the way.*
102+
*This is a good place to elaborate on your reasoning above -- for example, why did you put the design axioms in the order that you did? It's also a good place to put the answers to any questions that come up during discussion. The expectation is that this FAQ section will grow as the goal is discussed and eventually should contain a complete summary of the points raised along the way.*

0 commit comments

Comments
 (0)