Glance Contribution Guidelines

In the Contributions Guide, you will find documented policies for developing with Glance. This includes the processes we use for blueprints and specs, bugs, contributor onboarding, core reviewer memberships, and other procedural items.

This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Glance and other components of OpenStack can be found on the OpenStack wiki.

Getting Started

• 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
• Glance Code Reviews
  • Glance Spec Review Practices
  • Guidelines for core reviewers

Development Policies

• Disallowed Minor Code Changes
  • Database migration scripts
  • Typographical errors in comments
  • Misspellings in code
  • Tests
  • LOG.warn to LOG.warning
  • Gratuitous use of oslo libraries
• Guideline On Refreshing Configuration Files Under etc/
• When To Refresh The Sample Configuration Files

Development Practices

• Code Reviews
  • Gerrit
  • The Great Change
  • Unit Tests
• Blueprints and Specs
  • Spec Notes
  • Glance Spec Lite
    • Lite spec Submission Guidelines
• Release Notes
• Release Cycle Tasks
  • Before PTG (after closing previous release)
  • Between Summit and Milestone-1
  • Milestone-1
  • Between Milestone-1 and Milestone-2
  • Milestone-2
  • Between Milestone-2 and Milestone-3
  • Milestone-3
  • Between Milestone-3 and RC1
  • RC1 week
  • Between RC1 and Final
  • Final Release
  • Post-Final Release
• Glance Groups in Gerrit and Launchpad
  • Glance-related groups in Launchpad
  • Glance-related groups in Gerrit
    • How Gerrit groups are connected to project repositories
• Documentation
  • Tips for Doc Writers (and Developers, too!)
  • Where to Contribute
• Writing Database Migrations for Zero-Downtime Upgrades
  • Alembic Migrations
    • Schema Migrations (Expand/Contract)
    • Dependency Between Contract and Expand Migrations
    • Data Migrations
    • NOTES
  • References

Developer Reference

• Basic architecture
• Glance database architecture
  • Glance Database Public API
  • Glance Database Backends
• Domain model
  • Inner architecture
  • Proxies
  • Gateway
  • Helpers
  • Why do you need a domain if you can use decorators?
• Glance domain model implementation
  • Gateway and basic layers
• Module Reference
  • glance package

Development Roles

• Glance Release CPL
  • Who You Have to Be
  • What This Does Not Grant You
  • Get To Know The Release Team
  • Familiarize Yourself with Community Goals
  • Familiarize Yourself with the Release Tooling
  • Familiarize Yourself with the Bug Tracker
  • Release Stability and the Gate
  • Checklist

Managing the Development Cycle

• Release Cycle Tasks
• Glance Groups in Gerrit and Launchpad