Skip to content

Contributing

Thank you for your interest in contributing to Media Viewer!

For complete contributing guidelines, please see the CONTRIBUTING.md file in the root of the repository.

Overview

The main contributing guide covers:

  • Setting up your development environment
  • Code style guidelines
  • Testing requirements
  • Pull request process
  • Commit message conventions
  • Issue reporting templates

Documentation

If you're specifically interested in contributing to documentation:

  1. Documentation is written in Markdown
  2. Source files are in the docs/ directory
  3. Built with MkDocs Material theme
  4. Follow the MkDocs documentation for formatting

To preview documentation changes locally:

make docs-serve

Then open http://localhost:8000 in your browser.

Getting Help

If you have questions about contributing:

We appreciate your contributions!