Jump to: navigation, search

Difference between revisions of "NeutronContributorOnboarding"

Line 1: Line 1:
This page will document the following:
+
This page will document information for new contributors around:
* Information for new contributors around:
+
 
** Plugin APIs
+
* Plugin APIs
 
[https://www.youtube.com/watch?feature=player_detailpage&v=J0CNRH-aFpI#t=215 This is a video] of a presentation given by Mark McClain at Juno design summit in May 2014. It shows a nice overview of neutron-server, plugins, agents, plugin extensions and drivers.
 
[https://www.youtube.com/watch?feature=player_detailpage&v=J0CNRH-aFpI#t=215 This is a video] of a presentation given by Mark McClain at Juno design summit in May 2014. It shows a nice overview of neutron-server, plugins, agents, plugin extensions and drivers.
  
** Code walk throughs
+
* Code walk throughs
** Contributing to Neutron
+
 
 +
* Contributing to Neutron
 +
Work within Neutron is discussed in focused sub-teams that are dedicated to a particular area. The list of sub-groups within Neutron is [https://wiki.openstack.org/wiki/NeutronSubTeams available here]. Besides the weekly Neutron team meeting, each sub-team usually has a separate meeting to discuss and plan ongoing work in detail. A list of sub-teams and meeting times [https://wiki.openstack.org/wiki/Meetings#OpenStack_Networking_.28Neutron.29 is here]. Deciding which sub-team you are interested in, or your proposal/idea/fix may fit into is probably a good first step to contributing.
  
Work within Neutron is discussed in focused sub-teams that are dedicated to a particular area. The list of sub-groups within Neutron is [https://wiki.openstack.org/wiki/NeutronSubTeams available here]. Besides the weekly Neutron team meeting, each sub-team usually has a separate meeting to discuss and plan ongoing work in detail. A list of sub-teams and meeting times [https://wiki.openstack.org/wiki/Meetings#OpenStack_Networking_.28Neutron.29 is here].
+
[https://review.openstack.org/#/q/status:open+project:openstack/neutron,n,z Code reviews]  are a great way to learn about the project. There is also a list of [https://wiki.openstack.org/wiki/NeutronStarterBugs starter bugs] that may be useful as as a starting point. If you haven't already done so you should setup a Neutron development environment so you can actually run the code! Devstack is usually the most convenient way to setup such an environment: see [http://devstack.org/ devstack.org] and the [https://wiki.openstack.org/wiki/NeutronDevstack#Basic_Setup NeutronDevstack] information for editing the devstack local.conf file to include neutron services in the deployment.  
Deciding which sub-team you are interested in, or your proposal/idea/fix may fit into is probably a good first step to contributing.
 
  
[https://review.openstack.org/#/q/status:open+project:openstack/neutron,n,z Code reviews]  are a great way to learn about the project. There is also a list of [https://wiki.openstack.org/wiki/NeutronStarterBugs starter bugs] that may be useful as as a starting point.
+
* IRC information and etiquette
 +
The main irc channel is #openstack-neutron (on freenode). The weekly meeting is held in the #openstack-meeting channel. See the [https://wiki.openstack.org/wiki/Meetings#OpenStack_Networking_.28Neutron.29 list of meetings] for sub-team specific meeting rooms.
  
  
 +
* Mailing list information and etiquette
  
 +
* Neutron meeting information
  
** IRC information and etiquette
+
* https://wiki.openstack.org/wiki/Meetings#OpenStack_Networking_.28Neutron.29
** Mailing list information and etiquette
 
** Neutron meeting information
 
** https://wiki.openstack.org/wiki/Meetings#OpenStack_Networking_.28Neutron.29
 

Revision as of 14:14, 3 June 2014

This page will document information for new contributors around:

  • Plugin APIs

This is a video of a presentation given by Mark McClain at Juno design summit in May 2014. It shows a nice overview of neutron-server, plugins, agents, plugin extensions and drivers.

  • Code walk throughs
  • Contributing to Neutron

Work within Neutron is discussed in focused sub-teams that are dedicated to a particular area. The list of sub-groups within Neutron is available here. Besides the weekly Neutron team meeting, each sub-team usually has a separate meeting to discuss and plan ongoing work in detail. A list of sub-teams and meeting times is here. Deciding which sub-team you are interested in, or your proposal/idea/fix may fit into is probably a good first step to contributing.

Code reviews are a great way to learn about the project. There is also a list of starter bugs that may be useful as as a starting point. If you haven't already done so you should setup a Neutron development environment so you can actually run the code! Devstack is usually the most convenient way to setup such an environment: see devstack.org and the NeutronDevstack information for editing the devstack local.conf file to include neutron services in the deployment.

  • IRC information and etiquette

The main irc channel is #openstack-neutron (on freenode). The weekly meeting is held in the #openstack-meeting channel. See the list of meetings for sub-team specific meeting rooms.


  • Mailing list information and etiquette
  • Neutron meeting information