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 Searchlight.

Communication

Contacting the Core Team

New Feature Planning

  1. Talk to the team via IRC (meeting) or ML (with [searchlight] prefix) about the feature you want to add. We will discuss and figure out what is the best way forward considering our plan for the development cycle.

  2. After the team has discussed and everyone agreed to have your feature landed in the current cycle, you can propose a blueprint document describing your feature in details (e.g., architecture, components, usage, etc.)

  3. The team will review your blueprint and make comments until it is good enough to start implementing the feature.

  4. You implement the feature based on the design in the blueprint.

  5. Searchlight team will again review your code and approve it.

Task Tracking

We track our tasks in Storyboard If you’re looking for some smaller, easier work item to pick up and get started on, search for the ‘low-hanging-fruit’ tag.

Reporting a Bug

You found an issue and want to make sure we are aware of it? You can do so HERE.

Getting Your Patch Merged

Due to the small number of core reviewers of the Searchlight project, we only need one +2 before +W (merge). All patches excepting for documentation or typos fixes must have unit test.

Project Team Lead Duties

All common PTL duties are enumerated here in the PTL guide.