Skip to content

Commit

Permalink
[project] Update issue templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
Breakthrough committed Jun 29, 2023
1 parent 6f4e463 commit 44bd3e7
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 49 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Python API
about: Programmers using the `scenedetect` package.

---

**Description:**

Describe the issue (unexpected result, exception thrown, etc...) and any relevant output.

**Example:**

Include code samples that demonstrate the issue:

```python
from scenedetect import detect, ContentDetector, split_video_ffmpeg
scene_list = detect('my_video.mp4', ContentDetector())
split_video_ffmpeg('my_video.mp4', scene_list)
```

**Environment:**

Run `scenedetect version --all` and include the output. This will describe the environment/OS/platform and versions of dependencies you have installed.

**Media/Files:**

Attach or link to any files relevant to the issue, including videos (or YouTube links), scene files, stats files, and log output.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Application Bug
about: Help us fix and improve PySceneDetect by reporting bugs or other issues.

---

**Description:**

Describe what the bug or issue is (e.g. crashes when setting X) and how it can be reproduced.

**Command:**

Place a full copy of the command line options you are using here, for example:

`scenedetect -i some_video.mp4 -s some_video.stats.csv -o outdir detect-content --threshold 28 list-scenes save-images`

**Output:**

Copy the output of running the application here. Where possible, generate a debug log by adding `-v debug -l BUG_REPORT.txt` to the beginning of your command, and **attach `BUG_REPORT.txt` to your issue**.

**Environment:**

The operating system and how you installed PySceneDetect may be relevant to the issue. Please run `scenedetect version --all` and copy the output here, or provide other details on how PySceneDetect was installed.

**Media/Files:**

Attach or link to any files relevant to the issue, including videos (or YouTube links), scene files, stats files, and log output.
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug-or-issue-report.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature-or-enhancement-request.md

This file was deleted.

25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature or Enhancement
about: Submit an idea or feature request to make PySceneDetect better.

---

**Problem/Use Case**

Describe what problem you want to solve, or what use case you want to achieve. Ex. PySceneDetect doesn't work well in cases X or Y but if it could detect Z [...], PySceneDetect is slow because of X but could be faster if it did Y [...], or I need PySceneDetect to do X because of some condition Y [...].

**Solutions**

Discuss any potential solutions here.

**Proposed Implementation:**

Description of what you want to happen, and how you think the feature/enhancement should be implemented. Ex. what command line options/arguments should be added to PySceneDetect, and examples of how you expect them to function.

**Alternatives:**

List any alternative solutions or related ideas you've considered.

**Examples:**

Attach or link to any relevant videos or images that are relevant.

0 comments on commit 44bd3e7

Please sign in to comment.