Skip to content
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

Merged
merged 2 commits into from
Jul 8, 2021

Conversation

dblock
Copy link
Member

@dblock dblock commented Jun 23, 2021

Signed-off-by: dblock dblock@amazon.com

Description

Cleanup bug, feature and RFC templates.

Check List

  • Commits are signed per the DCO using --signoff

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.

@dblock
Copy link
Member Author

dblock commented Jun 23, 2021

@elfisher can I please ask you to take a look at this?

@dblock
Copy link
Member Author

dblock commented Jun 23, 2021

@jkowall since you originally PRed #7 please take a look? I am trying to make these templates look similar

Also what emoji should I use?

Copy link
Contributor

@elfisher elfisher left a 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.

ISSUE_TEMPLATE/RFC_TEMPLATE.md Outdated Show resolved Hide resolved
@dblock dblock force-pushed the cleanup-templates branch from c660728 to efe4fc5 Compare June 23, 2021 21:51
@jkowall
Copy link
Contributor

jkowall commented Jun 24, 2021

@jkowall since you originally PRed #7 please take a look? I am trying to make these templates look similar

Also what emoji should I use?

I think we need a proposal template. I don't understand what RFC would be used for exactly... Unclear the use cases for these.

@dblock
Copy link
Member Author

dblock commented Jun 24, 2021

@jkowall since you originally PRed #7 please take a look? I am trying to make these templates look similar
Also what emoji should I use?

I think we need a proposal template. I don't understand what RFC would be used for exactly... Unclear the use cases for these.

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?

@hyandell
Copy link
Contributor

Something to consider is including "For Security reports, go to X" in the issue reports.

@dblock
Copy link
Member Author

dblock commented Jun 25, 2021

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:

Screen Shot 2021-06-25 at 10 18 18 AM

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.

@jkowall
Copy link
Contributor

jkowall commented Jun 25, 2021

@jkowall since you originally PRed #7 please take a look? I am trying to make these templates look similar
Also what emoji should I use?

I think we need a proposal template. I don't understand what RFC would be used for exactly... Unclear the use cases for these.

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?

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.

@dblock
Copy link
Member Author

dblock commented Jun 25, 2021

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.

@dblock dblock force-pushed the cleanup-templates branch from efe4fc5 to faea9af Compare July 6, 2021 15:00
@dblock
Copy link
Member Author

dblock commented Jul 6, 2021

I'd like to merge this, but I want to make sure that @jkowall and @jmazanec15 at least agree that this is an improvement over what we had?

Let me think about what to do this after #19

dblock added 2 commits July 6, 2021 10:06
Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
@dblock dblock force-pushed the cleanup-templates branch from faea9af to 542c7a8 Compare July 6, 2021 15:26
@dblock dblock changed the title Cleanup bug, feature and RFC templates. Cleanup bug, feature and proposal templates. Jul 6, 2021
@dblock
Copy link
Member Author

dblock commented Jul 6, 2021

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
Copy link
Member Author

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.

Copy link
Contributor

@elfisher elfisher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this LGTM

@dblock dblock merged commit 7f6008d into opensearch-project:main Jul 8, 2021
@dblock dblock deleted the cleanup-templates branch August 3, 2021 14:14
emiaimi-aws added a commit that referenced this pull request Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants