Bringing proposal template in line with governance docs: specific changes for proposal #26
Conversation
|
Cross-linking to proposal #27! |
docs/issue_template.md
Outdated
|
|
||
| ## My proposal | ||
| 3. If you have a solution to this problem and you will implement it, continue, otherwise remove the **my proposal** section. | ||
| 1. Add a proposal title above that concisely summarizes the problem or suggestion. |
There was a problem hiding this comment.
I think adding the title after writing the problem (or proposal) leads to better titles. In the same way that writing a subject after writing an email leads to more informative subjects.
There was a problem hiding this comment.
Fine with me. I was mainly worried people would clear out all this text without getting that far down, and not read it.
docs/issue_template.md
Outdated
| 4. Add yourself as an assignee to this proposal. | ||
| 5. Replace this text with a clear statement of the solution you propose to implement, including any relevant supporting files. It can strengthen your proposal to include *pros* and *cons* and your thoughts about the *implications* (short and long term) of it being executed. | ||
| 5. If this is a strategic milestone, add the `strategy` milestone. | ||
| 6. If you have a solution to this problem and you will implement it, replace this text with a clear statement of the solution you propose to implement, including any relevant supporting files. It can strengthen your proposal to include *pros* and *cons*. If you have no solution, remove this Proposal section. |
There was a problem hiding this comment.
I think, ideally this should go before 4 as it is the first thing to do when deciding to make this a structured proposal instead of just reporting a problem.
docs/issue_template.md
Outdated
| 6. If you have a solution to this problem and you will implement it, replace this text with a clear statement of the solution you propose to implement, including any relevant supporting files. It can strengthen your proposal to include *pros* and *cons*. If you have no solution, remove this Proposal section. | ||
|
|
||
| ### Implications | ||
| 7. Replace this text with short-term (and, if relevant, long-term) implications of executing this proposal. |
There was a problem hiding this comment.
Might add "long-term implications are required for strategic proposals", or something to that effect.
|
@markwhiting, feel free to make the changes directly. I added you as a collaborator to my forked repo. |
docs/issue_template.md
Outdated
| ### Implications | ||
| 5. Replace this text with short-term (and, if relevant, long-term) implications of executing this proposal. If it is a strategy proposl, long-term implications are required. | ||
|
|
||
| ## Contact |
There was a problem hiding this comment.
For now to make sure attributions are clear, let's change Contact heading to Person or People Who Added the Proposal to GitHub
With a asterisk note below
**The person who added the proposal to GitHub--- the name in this section doesn't indicate that the person came up with this idea, unless and until explicitly and clearly mentioned.
and then names
XYZ
This pull request makes concrete the suggestions in the proposal "Change issue template to bring it in line with governance document". Please start there.