search

submariner-io / submariner-website

Content and Hugo-based generation for the Submariner website.
https://submariner.io/development/website/
Creative Commons Attribution 4.0 International
11 stars 51 forks source link

Contribution rules (RFEs) #9

Closed mangelajo closed 4 years ago

mangelajo commented 4 years ago

etc etc ...

mangelajo commented 4 years ago

Ideas: https://opendev.org/openstack/neutron-specs/src/branch/master/specs/template.rst for inspiration

nyechiel commented 4 years ago

Also need to look at: https://github.com/kubernetes/enhancements/blob/master/README.md

dfarrell07 commented 4 years ago

This might be related to https://github.com/submariner-io/submariner-website/issues/101

nyechiel commented 4 years ago

I plan to work on this. A quick summary of my thoughts:

  1. Use Case 1: “RFE”, someone asking for a missing feature
  1. Use Case 2: “spec”, a developer wanting to document their design proposal

/cc @mangelajo @skitt @dfarrell07

mangelajo commented 4 years ago

I plan to work on this. A quick summary of my thoughts:

  1. Use Case 1: “RFE”, someone asking for a missing feature

Probably this template should include a link to the enhancements repo template (when exists), suggesting that before development that would be necessary.

May be we should call this one rfe.md ? (to avoid the rfe/enhancement repo confusion part)?

  • TO DO: review the term and actual content of the template, and adopt across all repos
  1. Use Case 2: “spec”, a developer wanting to document their design proposal

  • Need to be used for major features, especially those who impact the user experience, change APIs, and/or present a notable change in behaviour. This is also a good way to ensure we think about testing, docs, and other such items while scoping the feature work

  • Miguel has created this repo for this: https://github.com/submariner-io/enhancements

  • TO DO: agree/clarify the term ("enhancement" creates a confusion with Use Case 1 above) I think the definition you made "major feature, changes API or behavior" is pretty clear. :+1:

  • TO DO: propose a template :+1:

  • TO DO: document the workflow as part of https://submariner-io.github.io/contributing/

/cc @mangelajo @skitt @dfarrell07

sridhargaddam commented 4 years ago

I plan to work on this. A quick summary of my thoughts:

  1. Use Case 1: “RFE”, someone asking for a missing feature

Probably this template should include a link to the enhancements repo template (when exists), suggesting that before development that would be necessary.

rfe.md makes sense and will avoid confusion. I hope not every RFE requires a design/spec in enhancement proposal as some of the RFEs can be minor changes.

May be we should call this one rfe.md ? (to avoid the rfe/enhancement repo confusion part)?

  • TO DO: review the term and actual content of the template, and adopt across all repos
  1. Use Case 2: “spec”, a developer wanting to document their design proposal

  • Need to be used for major features, especially those who impact the user experience, change APIs, and/or present a notable change in behaviour. This is also a good way to ensure we think about testing, docs, and other such items while scoping the feature work

  • Miguel has created this repo for this: https://github.com/submariner-io/enhancements

  • TO DO: agree/clarify the term ("enhancement" creates a confusion with Use Case 1 above) I think the definition you made "major feature, changes API or behavior" is pretty clear. +1

  • TO DO: propose a template +1

  • TO DO: document the workflow as part of https://submariner-io.github.io/contributing/

/cc @mangelajo @skitt @dfarrell07