Contributing to OpenCue

Welcome! We’re excited that you’re interested in contributing to OpenCue. This guide will help you get started with your first contribution.

Quick Start

1. Connect with the Community First

Before diving into code, connect with us! This helps avoid duplicate work and ensures your contribution aligns with the project’s direction.

Where to connect:

• Slack Channel - Best for quick questions and discussions
• GitHub Issues - For bug reports, feature requests, and tracking work
• Mailing Lists - For broader discussions and “how-to” questions

2. Set Up Your Development Environment

Prerequisites

• GitHub account
• Git installed locally
• Basic familiarity with Git workflows

Setup Steps

1. Fork the repository
   • Visit OpenCue on GitHub
   • Click “Fork” to create your own copy
2. Clone your fork locally

   git clone https://github.com/YOUR_USERNAME/OpenCue.git
   cd OpenCue
   

3. Add upstream remote

   git remote add upstream https://github.com/AcademySoftwareFoundation/OpenCue.git
   

4. Set up the development environment
   • Follow the sandbox testing guide
   • This provides a local OpenCue instance for testing