Contributor Documentation

Contributing to Cyborg gives you the power to help add features, fix bugs, enhance documentation, and increase testing. Contributions of any type are valuable, and part of what keeps the project going. Here are a list of resources to get your started.

Basic Information

• So You Want to Contribute…
  • Communication
  • Contacting the Core Team
  • New Feature Planning
  • Task Tracking
  • Reporting a Bug
  • Getting Your Patch Merged
  • Project Team Lead Duties

Contributing

• DevStack Setup for Development: DevStack setup guide for Cyborg development

• Creating Development VMs for Testing: Creating development VMs for testing

• Cyborg NVMe driver development environment: Cyborg NVMe driver development environment

• Running Cyborg Tempest Plugin Tests: Running Cyborg tempest plugin tests

• Upgrade Testing using grenade: Upgrade testing using grenade

• Using Cyborg with Your Instance: Using Cyborg with instances

Reviewing

• API Microversions: How the API is (micro)versioned and what you need to do when adding an API exposed feature that needs a new microversion.

• Release Notes: When we need a release note for a contribution.

• Driver Development Guide: Get your driver development guide to contribute

• Chronological Release Liaison Guide: Chronological guide for release liaisons