Home
Welcome to the PySceneDetect wiki! This wiki is used to coordinate development of the project. For documentation, visit https://www.scenedetect.com/docs/.
Features and bugs are addressed here on Github. Pull requests are encouraged.
Please base any pull requests for code changes against the develop branch. The website and documentation for scenedetect.com/docs/latest are built from main, and documentation for releases is built from their respective release/ branches.
When the next release is ready, a new branch is cut from develop (e.g. releases/0.6.2). When the release is ready and tagged (e.g. v0.6.2-release), it is merged back into main. Finally, develop is updated and merged with main, and development resumes.
Currently @Breakthrough and @wjs018 are the primary maintainers of the codebase and approvals for pull requests. If you have interest and are willing to make contributions to the project, we are actively seeking more maintainers/approvers.
Code needs to pass builds on Linux and Windows using different Python versions, and also must be linted according to the project's .style.yapf file.
Currently @Breakthrough is responsible for tagging, generating, and uploading each release. This includes the scenedetect package on PyPI, signed Windows .EXE builds, and the .MSI installer.
Documentation is generated from each release branch, and is hosted using Github Pages. Currently, documentation is generated with a Github Action workflow. This must be triggered manually currently, but can and may be automated in the future.
The website is generated from the main branch and is hosted using Github Pages. @Breakthrough owns and maintains the domain name scenedetect.com for the project. The website is updated automatically by Github Actions.