Jump to: navigation, search

Difference between revisions of "NeutronPlugins"

(Created page with "This page documents all Neutron plugins. This should also document the following: * A list of all current in-tree plugins with contact information, or a link to DriverLog. * R...")
 
Line 1: Line 1:
This page documents all Neutron plugins. This should also document the following:
+
== Plugin and Driver Processes ==
* A list of all current in-tree plugins with contact information, or a link to DriverLog.
+
Getting a plugin or driver merged upstream into Neutron allows you the benefit of being a part of the simultaneous release, and likely having your plugin or driver packaged with distributions which ship releases based on the simultaneous releases from upstream. However, this is not a "free ride", you should ideally be giving back more than you are taking by getting your code upstream. When you submit your code, you're putting a burden on the existing reviews and infrastructure. The same goes with subsequent bug fixes and backports to stable releases. Thus, you should have someone from your company or team reviewing other code upstream, participating in meetings, etc. The following is a list of requirements for inclusion of code upstream:
* Requirements for maintaining your plugin in-tree.
+
* Code which passes review, has adequate unit tests, and passes pep8 guidelines.
* Process for the following:
+
* A functioning CI system, which has been running successfully against your plugin/driver patches, and other patches as well.
** Getting your plugin in-tree.
+
* Participation in Neutron meetings, IRC channels, and email lists.
** Process for removing your plugin from tree if you fail the requirements above.
+
* A member of the plugin/driver team participating in code reviews of other upstream code.
 +
 
 +
=== Removal of Upstream Plugins or Drivers ===
 +
If you fail to meet the criteria above, you risk having your plugin or driver removed from upstream. The core team will continue to evaluate third party CI systems to ensure they are running and correctly testing patches for third party plugins and drivers. If they fail to function, an email will be sent to the openstack-dev mailing list asking for the owner to fix this issue. If the issue is not addressed within 2 weeks, a process to remove the plugin or driver from upstream will commence. To get your plugin or driver upstream after it has been removed will take a functioning third party CI system running for a month, correctly voting on changes upstream.

Revision as of 13:42, 10 June 2014

Plugin and Driver Processes

Getting a plugin or driver merged upstream into Neutron allows you the benefit of being a part of the simultaneous release, and likely having your plugin or driver packaged with distributions which ship releases based on the simultaneous releases from upstream. However, this is not a "free ride", you should ideally be giving back more than you are taking by getting your code upstream. When you submit your code, you're putting a burden on the existing reviews and infrastructure. The same goes with subsequent bug fixes and backports to stable releases. Thus, you should have someone from your company or team reviewing other code upstream, participating in meetings, etc. The following is a list of requirements for inclusion of code upstream:

  • Code which passes review, has adequate unit tests, and passes pep8 guidelines.
  • A functioning CI system, which has been running successfully against your plugin/driver patches, and other patches as well.
  • Participation in Neutron meetings, IRC channels, and email lists.
  • A member of the plugin/driver team participating in code reviews of other upstream code.

Removal of Upstream Plugins or Drivers

If you fail to meet the criteria above, you risk having your plugin or driver removed from upstream. The core team will continue to evaluate third party CI systems to ensure they are running and correctly testing patches for third party plugins and drivers. If they fail to function, an email will be sent to the openstack-dev mailing list asking for the owner to fix this issue. If the issue is not addressed within 2 weeks, a process to remove the plugin or driver from upstream will commence. To get your plugin or driver upstream after it has been removed will take a functioning third party CI system running for a month, correctly voting on changes upstream.