First off, thank you for considering contributing to Media Fusion! We appreciate your effort and contribution. This document provides guidelines and steps for contributing.
By participating, you are expected to uphold this code. Please report unacceptable behavior.
- Ensure the bug was not already reported by searching on GitHub.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title, clear description, and the necessary information to reproduce the bug.
- Open a new issue with a clear title and detailed description.
- Provide a step-by-step description of the suggested enhancement.
- Fork the repo.
- Create your feature branch:
git checkout -b my-new-feature
. - Commit your changes:
git commit -am 'Add some feature'
. - Push to the branch:
git push origin my-new-feature
. - Submit a pull request.
- Clone the repository.
- Install dependencies using
pipenv install
. - Follow the instructions in the
README.md
to set up the environment variables.
Ensure your code adheres to the PEP8 style guide for Python and use black
to format your code.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Ensure your PRs are small, focused, and solve only one issue or add one feature.
- Include comments in your code where necessary.
Thank you for your contribution!