kolla/doc/source/contributor/contributing.rst
Radosław Piliszek 7b0acfea11 [docs] Add Kolla design philosophy
As discussed during the last PTG (Antelope 2023.1) [1].

The added page discusses two properties of the Kolla ecosystem
that are important mostly to contributors.

Clean up the "Contributing" page a bit along the way.

[1] https://etherpad.opendev.org/p/kolla-antelope-ptg

Change-Id: I0c7dd35ac9bbd050b708d5baae2504d3bd56828d
2022-11-22 09:46:41 +01:00

3.4 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 Kolla.

Basics

The source repository for this project can be found at:

https://opendev.org/openstack/kolla

Communication

IRC Channel

#openstack-kolla (channel logs) on OFTC

Weekly Meetings

On Wednesdays at 14:00 UTC in the IRC channel (meetings logs)

Mailing list (prefix subjects with [kolla])

https://lists.openstack.org/pipermail/openstack-discuss/

Meeting Agenda

Meeting agenda <meeting-agenda>

Whiteboard (etherpad)

Keeping track of CI gate status, release status, stable backports, planning and feature development status. https://etherpad.openstack.org/p/KollaWhiteBoard

Contacting the Core Team

In general it is suggested to use the above mentioned public communication channels, but if you find the you need to contact someone from the Core team directly, you can find the lists in Gerrit:

New Feature Planning

New features are discussed via IRC or mailing list (with [kolla] prefix). Kolla project keeps blueprints in Launchpad. Specs are welcome but not strictly required.

Task Tracking

Kolla project tracks tasks in Launchpad. Note this is the same place as for bugs.

If you're looking for some smaller, easier work item to pick up and get started on, search for the 'low-hanging-fruit' tag.

A more lightweight task tracking is done via etherpad - Whiteboard.

Reporting a Bug

You found an issue and want to make sure we are aware of it? You can do so on Launchpad. Note this is the same place as for tasks.

Getting Your Patch Merged

Most changes proposed to Kolla require two +2 votes from core reviewers before being approved and sent to the gate queue for merging. A release note is required on most changes as well. Release notes policy is described in its own section <release-notes>.

Significant changes should have documentation and testing provided with them.

Project Team Lead Duties

All common PTL duties are enumerated in the PTL guide. Kolla-specific PTL duties are listed in Kolla PTL guide.