Developer Guide

Note

This section is sourced from the OSM Developer Guide documentation repository. The original repository is no longer a primary reference; this user guide is the canonical location.

• Understanding the Workflow with OSM tools
  • Login to OSM portal
  • Reporting a bug on Bugzilla
  • Proposing a new Feature
  • Funnel of a feature
  • Designing a feature
  • OSM CI/CD
  • Join the Community
• Prepare your environment
  • 1. Create an SSH key
  • 2. Add your public key to GitLab
  • 3. Configure ~/.ssh/config
  • 4. Configure Git
  • 5. Clone a project
• Contributing Code
  • Python 3
  • License Headers
  • Make a change — Git Flow
    • Developer’s Certificate of Origin
  • Push your contribution to GitLab
  • Continuous Integration
    • Stage 1 — Per-module
    • Stage 2 — Common E2E
  • Code Review
  • Approval from TSC
  • Amending a contribution
    • Amending a change from another author
    • Amending a change with dependent commits
  • Fixing the author name / email
• Testing before committing
  • Check your Python version
  • Install dependencies in a virtual environment
  • Run the test suite
  • Run Robot (E2E) tests
• Resolving merge conflicts
  • Simple rebase using the GitLab UI
  • Manual rebase
    • 1. Get the latest code from the target branch
    • 2. Switch to your MR branch and rebase
    • 3. Resolve conflicts
    • 4. Continue the rebase
    • 5. Push the rebased branch
• Developer Guides for Specific OSM Modules
  • Developer Guide for RO Module
    • Getting Started
    • Programming Language
    • Directory Organization
    • RO Architecture
    • Creating a new VIM plugin
    • Creating a new SDN/WIM plugin
  • Developer Guide for OSM client
  • kafka messages
  • Developer Guide for OpenVIM
    • Getting Started
    • Programming Language
    • Code Style
    • Directory Organization
    • Openvim Architecture
    • Database changes
    • CLI client
    • Northbound Interface
    • Running Unit Tests
    • Creating a new SDN plugin
• How to contribute to documentation