howtocontribute.md

How to Contribute Code to VDO.Ninja

Step 1: Fork the Repository

1. Go to https://github.com/steveseguin/vdo.ninja
2. Click the "Fork" button (top right)
3. This creates your own copy of VDO.Ninja

Step 2: Clone Your Fork

git clone https://github.com/YOUR-USERNAME/vdo.ninja.git
cd vdo.ninja

Step 3: Create a New Branch

# Branch from develop, not main
git checkout develop
git checkout -b your-feature-name

Step 4: Make Your Changes

• Edit/add your files
• Test your changes locally
• Follow existing code style

Step 5: Commit Your Changes

git add .
git commit -m "Brief description of changes"

Step 6: Push to Your Fork

git push origin your-feature-name

Step 7: Create a Pull Request

1. Go to your fork on GitHub
2. Click "Pull requests" → "New pull request"
3. Important: Set base branch to develop (not main)
4. Select your feature branch
5. Click "Create pull request"
6. Add clear title and description
7. Submit

Step 8: Sign the CLA

• The CLA Assistant bot will comment on your PR
• Click the link to digitally sign the CLA
• This only needs to be done once

Important Notes:

• Always PR to the develop branch, not main
• Test your changes before submitting
• One feature per PR is preferred

Keeping Your Fork Updated

# Add upstream remote
git remote add upstream https://github.com/steveseguin/vdo.ninja.git

# Update your fork's develop branch
git checkout develop
git fetch upstream
git merge upstream/develop
git push origin develop

Can't Create a PR?

Email your code to [email protected] with:

• Your code changes
• Statement: "I agree to the VDO.Ninja CLA terms"
• Your full legal name