This patch also changes CONTRIBUTING.rst file in root directory of the repo to fit with new cookiecutter template proposed in the community goal description. Change-Id: I190afcff68c4a20f42aec34cb299bd862e7c7efd Story: #2007236 Task: #38540
6.8 KiB
So You Want to Contribute...
For general information on contributing to OpenStack, please check out the contributor guide to get started. It covers all the basics that are common to all OpenStack projects: the accounts you need, the basics of interacting with our Gerrit review system, how we communicate as a community, etc.
Below will cover the more project specific information you need to get started with Neutron.
Communication
IRC channel: #openstack-neutron
Mailing list's prefix: [neutron]
Team Meeting:
This is general Neutron team meeting. The discussion in this meeting is about all things related to the Neutron project, like community goals, progress with blueprints, bugs, etc. There is also
On Demand Agenda
at the end of this meeting, where anyone can add a topic to discuss with the Neutron team.Drivers team meeting:
This is the meeting where Neutron drivers discuss about new RFEs.
Neutron CI team meeting:
This is the meeting where upstream CI issues are discussed every week. If You are interested in helping our CI to be green, that's good place to join and help.
Neutron QoS team meeting:
This is the meeting of the Neutron Quality of Service subteam.
Neutron L3 team meeting:
This is the meeting of the Neutron L3 subteam where all issues related to IPAM, L3 agents, etc. are discussed.
Contacting the Core Team
The list of current Neutron core reviewers is available on gerrit.
Overall structure of Neutron team is available in Neutron teams<neutron_teams>
.
New Feature Planning
Neutron team uses RFE (Request for Enhancements)
to
propose new features. RFE should be submitted as a Launchpad bug first
(see section reporting_a_bug
). The title of RFE bug should starts
with [RFE]
tag. Such RFEs need to be discussed and approved
by the Neutron drivers
team<drivers_team>
. In some cases an additional spec
proposed to the Neutron specs
repo may be necessary. The complete process is described in detail in
Blueprints
guide<neutron_blueprints>
.
Task Tracking
We track our tasks in Launchpad. If you're
looking for some smaller, easier work item to pick up and get started
on, search for the Low
hanging fruit tag. List of all official tags which Neutron team is
using is available on bugs<neutron_bugs>
. Every week, one of our team
members is the bug
deputy<neutron_bug_deputy>
and at the end of the week such
person usually sends report about new bugs to the mailing list openstack-discuss@lists.openstack.org
or talks about it on our team meeting. This is also good place to look
for some work to do.
Reporting a Bug
You found an issue and want to make sure we are aware of it? You can do so on Launchpad. More info about Launchpad usage can be found on OpenStack docs page.
Getting Your Patch Merged
All changes proposed to the Neutron or one of the Neutron stadium
projects require two +2 votes from Neutron core reviewers before one of
the core reviewers can approve patch by giving Workflow +1
vote. More detailed guidelines for reviewers of Neutron patches are
available at Code reviews guide<code_review>
.
Project Team Lead Duties
Neutron's PTL duties are described very well in the All common PTL duties guide. Additionally to what is described in this guide, Neutron's PTL duties are:
- triage new RFEs and prepare Neutron drivers team meeting,
- maintain list of the
stadium projects<neutron_stadium>
health - if each project has gotten active team members and if it is following community and Neutron's guidelines and goals, - maintain list of the
stadium projects lieutenants<subproject_lieutenants>
- check if those people are still active in the projects, if their contact data are correct, maybe there is someone new who is active in the stadium project and could be added to this list.
Over the past few years, the Neutron team has followed a mentoring approach for:
- new contributors,
- potential new core reviewers,
- future PTLs.
The Neutron PTL's responsibility is to identify potential new core reviewers and help with their mentoring process. Mentoring of new contributors and potential core reviewers can be of course delegated to the other members of the Neutron team. Mentoring of future PTLs is responibility of the Neutron PTL.