Contributing to validations-common

If you’re interested in contributing to the validations-common project, the following will help get you started:

If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool:

Pull requests submitted through GitHub will be ignored.

Validations are meant to verify functionality of tripleo systems. Therefore a special care should be given to testing your code before submitting a review.

The information below will cover the project specific information you’ll need to get started with validation-framework.

Branches and version management

Validation Framework project uses semantic versioning and derives names of stable branches from the released minor versions. The latest minor version released is the only exception as it is derived from the master branch.

Therefore, all code used by version 1.n.* of the project resides in stable/1.n branch, and when version 1.(n+1) is released, new branch stable/1.(n+1) will be created.

By default, stable branches recieve only bug fixes and feature backports are decided on case basis after all the necessary discussions and procedures have taken place.

Documentation

For description of provided validations, modules and tools please refer to the upstream documentation. Separate documentation is provided about the runtime, validations-libs

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.

Communication

Contacting the Core Team

Please refer to the TripleO Core Team contacts.

Bug Tracking

We track our tasks in Launchpad and in StoryBoard

Reporting a Bug

You found an issue and want to make sure we are aware of it? You can do so on Launchpad. Please, add the validations tag to your bug.

More info about Launchpad usage can be found on OpenStack docs page

Getting Your Patch Merged

All changes proposed to the TripleO requires two Code-Review +2 votes from TripleO core reviewers before one of the core reviewers can approve patch by giving Workflow +1 vote.

Project Team Lead Duties

All common PTL duties are enumerated in the PTL guide.

The Release Process for TripleO is documented in Release Management.

Documentation for the TripleO project can be found here