- Create a card on the task board in the "To do" column, named something like "{my feature} Proposal"
- When ready to start work, use "Convert to issue" and move it to the "In progress" column
- Aim to cover the following when writing your spec:
- Goals & Non-goals.
- High level syntax (note, it's fine to start with something hand-wavy, just aim to refine and come up with something concrete post-discussion).
- Example syntax uses.
- Move the issue into "In review" and request reviews from the relevant team members.
- Address comments either by amending the issue or justifying why you don't think it should be adopted.
- If you're unable to reach a conclusion, reach out to the Benevolant Dictator to make a decision.
- Move your card to "Done" and start work on the PR to incorporate your proposal.
TBD. Notes:
- Ensure grammar and spec are kept up-to-date.
- Ensure you have round-trip tests covering the new syntax.
- Keep the reference templates (links TBD) up-to-date with your new syntax.
Please add to this list with new considerations.
- How does this concept fit stylistically with the existing spec?
- How intuitive will this feel to read and write to programmers and non-programmers?
- What will error recovery look like if the syntax has been partially typed?
- What will IDE suggestions, errors and completions look like within this syntax?