Contributing to whisper-vtt2srt

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them.

Table of Contents

• Code of Conduct
• How Can I Contribute?
• Reporting Bugs
• Suggesting Enhancements
• Pull Requests
• Styleguides

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for whisper-vtt2srt. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for whisper-vtt2srt, including completely new features and minor improvements to existing functionality.

Pull Requests

1. Fork the repo and create your branch from main.
2. Make sure to add tests for any new logic!
3. Ensure the test suite passes (pytest).
4. Ensure your code is formatted with ruff/black.
5. Issue that pull request!

Styleguides

Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line