-
Notifications
You must be signed in to change notification settings - Fork 70
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
Cleanup bug, feature and proposal templates. #18
Conversation
@elfisher can I please ask you to take a look at this? |
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.
This LGTM. Optionally, I'd add in the RFC template a section where authors can request specific things to be commented on.
c660728
to
efe4fc5
Compare
Don't you think that proposal as is is duplicating a feature request? I was thinking RFC is better differentiated from feature requests. RFCs are proposals but more standard. WDYT? |
Something to consider is including "For Security reports, go to X" in the issue reports. |
When you open an issue in a repo that has a SECURITY.md you see this: We definitely don't want to add a security template because we don't want people to open security issues (they become 0-days). So I don't think anything needs to be added, but correct me if I am wrong. |
Proposal is for someone who wants to propose and contribute. Feature request is for someone who wants a feature who likely cannot build it (backlog). Up to you. |
I see what you mean, @jkowall. I think the questions you ask in a proposal are the same as in an RFC. Am I wrong? I am thinking of changing "Describe an idea and request comments in this project" to "Make a proposal and request comments in this project" in the template if we believe that's true. |
Let me think about what to do this after #19 |
Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
I made all 3 templates look and feel the same. Most changes are in PROPOSAL_TEMPLATE, but I did not change the material content of it. @jmazanec15 @jkowall @elfisher take a look? |
- Try to provide as much detail as possible | ||
- Please delete the comments before posting | ||
- When opening a feature request you should expect to contribute a solution or part of this to make it a reality. | ||
- Think of this like a requirements doc a product manager may fill out but with less rigor typically |
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.
This is some content from the COC, and some that's general across all issues, so I removed it to avoid saying different things in different places. The comments are also not something GitHub shows in any interesting ways, so I think writers of issues should overwrite the text just like in the bug and feature templates alongside proposal.
Now, if we do think we should have a comment section like this, we can add it in all templates. In this PR I am voting to remove it.
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.
this LGTM
Signed-off-by: dblock dblock@amazon.com
Description
Cleanup bug, feature and RFC templates.
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.