Skip to content

FunASR-powered video transcription, subtitle generation, and LLM-assisted clipping tool with a local Gradio UI.

Add FunClip community templates (#188)

zhifu gaobb010c542f6e
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..1815cc6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,52 @@
+---
+name: Bug report
+description: Report a reproducible FunClip failure or incorrect clipping result
+title: "[Bug] "
+labels: ["bug"]
+---
+
+## Summary
+
+Describe the problem in one or two sentences.
+
+## Environment
+
+- FunClip version or commit:
+- FunASR version:
+- Operating system:
+- Python version:
+- Installation method:
+- Browser or Gradio version, if using the web UI:
+- GPU/CPU and CUDA version, if relevant:
+
+## Audio or video input
+
+- File type and duration:
+- Language:
+- Public sample link or a minimal synthetic sample, if possible:
+- ASR model and hotwords:
+- LLM provider/model, if the issue involves semantic clipping:
+
+## Steps to reproduce
+
+1.
+2.
+3.
+
+## Expected behavior
+
+What should happen?
+
+## Actual behavior
+
+What happened instead?
+
+## Logs or traceback
+
+```text
+Paste the full error, command output, or browser console log here.
+```
+
+## Screenshots or clips
+
+Attach screenshots, subtitles, timestamps, or before/after clips when they help explain the issue.
diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml
new file mode 100644
index 0000000..bed3991
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yaml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+ - name: FunASR documentation
+ url: https://modelscope.github.io/FunASR/
+ about: Read the upstream ASR toolkit documentation.
+ - name: FunASR GitHub discussions
+ url: https://github.com/modelscope/FunASR/discussions
+ about: Ask broader ASR, deployment, or model-selection questions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..631dcfd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,32 @@
+---
+name: Feature request
+description: Suggest a FunClip workflow, model, UI, or deployment improvement
+title: "[Feature] "
+labels: ["enhancement"]
+---
+
+## Use case
+
+What are you trying to do with FunClip?
+
+## Proposed behavior
+
+Describe the workflow or API you would like.
+
+## Current workaround
+
+How do you handle this today?
+
+## Input and output examples
+
+- Input audio/video type:
+- Expected transcript, subtitle, clip, or export format:
+- Target language or scenario:
+
+## User impact
+
+Who benefits from this change and how often would they use it?
+
+## Related tools or references
+
+Link related projects, papers, demos, or screenshots if useful.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..f5e15e6
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,21 @@
+## Summary
+
+- TODO
+
+## User impact
+
+Who benefits from this change, and what FunClip workflow improves?
+
+## Validation
+
+- [ ] I ran the relevant tests or commands:
+- [ ] I checked the affected README/docs links, if changed.
+- [ ] I verified the affected UI, API, ASR, LLM, or clipping path, if changed.
+
+## Screenshots or clips
+
+Add before/after screenshots, subtitles, timestamps, or short clips for UI or clipping-result changes.
+
+## Notes for reviewers
+
+Mention any follow-up work, known limitations, or files that deserve extra attention.
diff --git a/tests/test_github_templates.py b/tests/test_github_templates.py
new file mode 100644
index 0000000..f091836
--- /dev/null
+++ b/tests/test_github_templates.py
@@ -0,0 +1,45 @@
+from pathlib import Path
+
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+def test_issue_templates_collect_funclip_repro_details():
+ template_dir = ROOT / ".github" / "ISSUE_TEMPLATE"
+ required_files = [
+ "bug_report.md",
+ "feature_request.md",
+ "config.yaml",
+ ]
+
+ for name in required_files:
+ assert (template_dir / name).exists()
+
+ bug_text = (template_dir / "bug_report.md").read_text()
+ required_bug_fields = [
+ "FunClip version or commit",
+ "FunASR version",
+ "Operating system",
+ "Python version",
+ "Audio or video input",
+ "Expected behavior",
+ "Actual behavior",
+ "Logs or traceback",
+ ]
+ for field in required_bug_fields:
+ assert field in bug_text
+
+
+def test_pull_request_template_keeps_validation_visible():
+ template = ROOT / ".github" / "PULL_REQUEST_TEMPLATE.md"
+ assert template.exists()
+
+ text = template.read_text()
+ required = [
+ "Summary",
+ "Validation",
+ "User impact",
+ "Screenshots or clips",
+ ]
+ for marker in required:
+ assert marker in text