Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (55 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

75 lines (55 loc) · 1.98 KB
Raw

Contributing to Claude Remotion Editor

Thank you for your interest in contributing!

How to Contribute

Reporting Issues

  • Open an issue describing the bug or feature request
  • Include reproduction steps for bugs
  • Include screenshots/videos for visual issues

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes
  4. Test with npm run dev (Remotion Studio)
  5. Render a test video: npm run render
  6. Submit a pull request

Development Setup

git clone https://github.com/ytrofr/claude-remotion-editor.git
cd claude-remotion-editor
npm install
npm run dev    # Opens Remotion Studio on port 3000

Project Structure

src/
  compositions/     # Video compositions (each is a separate demo)
  components/       # Reusable components (PhoneMockup, FloatingHand, etc.)
public/
  mobile/           # Screenshot assets
  lottie/           # Lottie animation files
  audio/            # Sound effects
scripts/            # Capture and utility scripts

Code Style

  • TypeScript for all source files
  • Remotion conventions (useCurrentFrame, useVideoConfig, etc.)
  • Use staticFile() for assets in public/
  • Use random('seed') instead of Math.random() for deterministic renders

Adding New Compositions

  1. Create a directory in src/compositions/YourDemo/
  2. Register in src/Root.tsx
  3. Add render script in package.json
  4. Document in CLAUDE.md

Adding Lottie Animations

  1. Download from LottieFiles
  2. Save as JSON in public/lottie/
  3. Keep under 100KB for performance
  4. Register in src/compositions/SceneDirector/panels/galleryData.ts
  5. Use delayRender() + continueRender() pattern

Generating Cursor Animations

python3 scripts/generate-real-arrow-anims.py
# Outputs 26 files to public/lottie/cursor-real-anim-*.json

License

By contributing, you agree that your contributions will be licensed under the MIT License.