Submitting an Issue Guidelines¶
If you've discovered a bug or have an idea that could improve DeFFcode, we’d love to hear from you. Before opening an issue, please review the guidelines below—they help us triage faster and resolve issues more efficiently.
Before You Start¶
First issue on GitHub?
You can learn how to create one from GitHub’s official guide on creating an issue.
Info
Issues can usually be resolved much faster when they include clear reproduction steps, environment details, and a small demo.
If you're short on time, feel free to submit a brief report—but please note that incomplete reports may take longer to investigate.
Search the Documentation and Existing Issues¶
Before opening a new issue, please check the following first:
- Search for an existing open or closed issue that matches your problem.
- Review the FAQ & Troubleshooting section.
- For quick questions, use our Gitter community instead of opening an issue.
You may find that your question has already been answered or that a workaround already exists.
Gather Required Information¶
Please include the following information with your report whenever possible:
- Enable the
verbose=Trueflag in the relevant API to collect debug logs. - Provide a minimal reproducible example that demonstrates the issue.
- Include the installed DeFFcode version using command:
python -c "import deffcode; print(deffcode.__version__)"and also:- Python version
- Operating system
- FFmpeg version (
ffmpeg -version)
Follow the Issue Template¶
- Select the correct issue template before submitting.
- Complete all relevant sections in the template.
- Reports with insufficient information may be marked Invalid ⛔
- If no follow-up details are provided, the issue may be closed.
Raise the Issue¶
Before submitting:
- Write a short but descriptive title
- Keep the report focused on one issue
- Attach relevant logs, screenshots, or source code when available
Choose the appropriate template below: