Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

93 lines (62 loc) · 2.71 KB

Contributing to Rendervid

We're excited that you're interested in contributing to Rendervid! This document outlines how you can help improve the project.

Ways to Contribute

Report Issues

Found a bug or have a feature request? Open an issue and let us know. When reporting issues, please include:

  • A clear and descriptive title
  • Steps to reproduce the problem (for bugs)
  • Expected vs actual behavior
  • Your environment (OS, Node.js version, etc.)
  • Relevant template JSON or code snippets

Share Ideas

Have an idea for a new feature, template type, or improvement? We'd love to hear it! Open an issue with the "enhancement" label and describe:

  • What problem it solves
  • How it would work
  • Any examples or mockups

Submit Code

Want to contribute code? Great! Here's how:

  1. Fork the repository and create your branch from main
  2. Make your changes following our coding style
  3. Test your changes thoroughly
  4. Submit a pull request with a clear description

Pull Request Guidelines

  • Keep changes focused and atomic
  • Include tests for new functionality
  • Update documentation if needed
  • Follow existing code style and conventions
  • Reference any related issues

Add Examples

New template examples are always welcome! To add an example:

  1. Create a new directory in the appropriate category under examples/
  2. Include a template.json with your template definition
  3. Add a README.md explaining the example
  4. Run npm run generate-previews to create the preview image/GIF
  5. Submit a pull request

Improve Documentation

Documentation improvements are valuable contributions:

  • Fix typos or clarify existing docs
  • Add new tutorials or guides
  • Improve code comments
  • Translate documentation

Code Style

  • Use meaningful variable and function names
  • Keep functions small and focused
  • Comment complex logic
  • Follow existing patterns in the codebase

Review Process

All contributions go through a review process:

  1. Initial Review: We'll review your submission for completeness and alignment with project goals
  2. Testing: We'll test the changes to ensure they work correctly
  3. Feedback: We may request changes or improvements
  4. Merge: Once approved, we'll merge your contribution

We aim to review all contributions promptly, but please be patient as this is an open-source project.

Community Guidelines

  • Be respectful and constructive
  • Welcome newcomers
  • Focus on the issue, not the person
  • Help others learn and grow

Questions?

If you have questions about contributing, feel free to:

  • Open an issue with your question
  • Check existing issues and discussions

Thank you for helping make Rendervid better!