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.
Quick Links
- Report a Bug - Found an issue? Let us know
- Request a Feature - Have an idea? We'd love to hear it
- Discussions - Ask questions or share ideas
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:
- Documentation is written in Markdown
- Source files are in the
docs/directory - Built with MkDocs Material theme
- Follow the MkDocs documentation for formatting
To preview documentation changes locally:
Then open http://localhost:8000 in your browser.
Getting Help
If you have questions about contributing:
- Check the Architecture documentation for technical details
- Open a Discussion
- Comment on an existing issue
We appreciate your contributions!