-
Notifications
You must be signed in to change notification settings - Fork 35
Update issue templates #305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. A few nits, if I understood correctly the syntax.
[A clear and concise description of what the bug is] | ||
|
||
**To Reproduce** | ||
1. [Steps to reproduce] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. [Steps to reproduce] | |
[Steps to reproduce] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to suggest providing steps as a numbered list, if it makes sense.
**[Risks]** | ||
[Optional: Consider risks and mitigations, if relevant] | ||
|
||
**Alternatives** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**Alternatives** | |
**[Alternatives]** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, should be other way around: "Optional" removed from the description.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed by removing "Optional"
[A clear and concise description of any alternative solutions or features you've considered] | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add any other context or screenshots about the feature request here. | |
[Add any other context or screenshots about the feature request here.] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will fix, thanks!
[A clear and concise description of any alternative solutions or features you've considered] | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Missing surrounding []
.
.github/ISSUE_TEMPLATE/rfc.md
Outdated
[Optional: Highlight why the proposal makes sense, especially if this is not a problem solving, but exploiting an opportunity] | ||
|
||
**[Implementation or Transition]** | ||
[Optional: Some solutions many need multiple steps to be implemented or require migration/transition period from the previous approach - outline the plan here] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: many -> may
[Optional: Some solutions many need multiple steps to be implemented or require migration/transition period from the previous approach - outline the plan here] | |
[Optional: Some solutions may need multiple steps to be implemented or require a migration/transition period from the previous approach - outline the plan here] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will fix, thanks!
Change-Id: I87705dc1bbcc8c60384539184f5a28b91d282095
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LG
No description provided.