Developer Guide

Contents:

• Introduction
  • Purpose
• Contributing
  • Welcome
  • Ways to Contribute
  • Requirements
  • Submitting Pull Requests
    • Find or Create a GitHub Issue
    • Create a New Branch off the main Branch
    • Commit Your Change to Your New Branch
    • Rebase as Needed
    • Push Your Branch to GitHub
    • Make a Pull Request
• Logistics
  • Development Environment
    • Install Rust
    • Install Python
    • Clone the OpenDP Repo
  • Building OpenDP
    • Build OpenDP
    • Install Python Dependencies
    • Run the Tests
  • Documentation
    • Documentation Source
    • Building the Docs
• Code Structure
  • Constructor Functions
  • Proofs
  • FFI Wrappers
• Review Process
  • Matching Proof Pseudocode to Implementation
  • Validating Privacy Claims
• Committer Notes
  • Summary
    • Rationale
  • Task Tracking
  • Code Hygiene
  • Branching Strategy
  • Release Process
    • Overview
    • Playbook
    • Release Workflows
      • sync-branches.yml
      • release.yml
      • docs.yml

previous

Frequently Asked Questions

next

Introduction