Strong community interest, but docs and engineering haven't caught up to the hype.
the subtitle editor :)
Documentation
58
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README documents how to install the project.
README is present.
Licensed under MIT.
Engineering
62
No .NET formatter configured.
→ Add an .editorconfig to define C# formatting rules and run `dotnet format` in CI.
No issue or PR templates found (−100 pts).
→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
Lockfile present (src/ui/packages.lock.json). Installs are reproducible.
Test files detected (tests).
CI is configured (.github/workflows/build-flatpak.yml).
Project health
100
Dependency manifest found (SubtitleEdit.sln).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository files18 root entries
- .githubGood: CI is configured (.github/workflows/build-flatpak.yml).
- Dictionaries
- docs
- installer
- Ocr
- srcGood: Lockfile present (src/ui/packages.lock.json). Installs are reproducible.
- testsGood: Test files detected (tests).
- Themes
- .gitignoreGood: .gitignore present.
- appveyor.yml
- change-log.txt
- Changelog.txt
- Directory.Build.props
- LICENSEGood: Licensed under MIT.
- make-installer.bat
- README.mdGood: README is present.Good: README is well structured with multiple sections.Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.Good: README has code examples.Good: README links to a live demo or deployed app.Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.Good: README documents how to install the project.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- SubtitleEdit.slnGood: Dependency manifest found (SubtitleEdit.sln).
- SubtitleEdit.sln.DotSettings