docs: add contributing, security and conduct guides; link the live demo - #1
Merged
Conversation
Makes the repository usable by someone who arrives without context. CONTRIBUTING.md names the one closed door — performance rating, effort estimation, per-person scoring — and then says plainly that everything else is open, with the most useful contribution named: a measured detection-accuracy number on hand-labelled real footage, which is the gap the README already admits to. It also records the trap that shipped once: a dependency merely installed in a local venv passes locally and breaks every clean install. SECURITY.md leads with the boundary that actually matters here. This processes video of identifiable people at work, so a leak is footage of named employees rather than a table of hashes. The reportable finding is anything that gets a frame, a track, a worker name or a report onto the network, plus injection through config values that reach the Jinja template. Detection inaccuracy is explicitly out of scope, since the README already states it is unvalidated. CODE_OF_CONDUCT.md is Contributor Covenant 2.1 with a real contact route. The README now opens the demo section with the hosted report, so a visitor can see the deliverable before deciding whether to install anything.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes the repository usable by someone who arrives without context.
CONTRIBUTING.md names the one closed door — performance rating, effort estimation, per-person scoring — then says plainly that everything else is open, and names the most useful possible contribution: a measured detection-accuracy number on hand-labelled real footage, which is the gap the README already admits to. It also records the trap that shipped once here: a dependency merely installed in a local venv passes locally and breaks every clean install.
SECURITY.md leads with the boundary that actually matters. This processes video of identifiable people at work, so a leak is footage of named employees, not a table of hashes. The reportable finding is anything that gets a frame, a track, a worker name or a report onto the network — plus injection through config values that reach the Jinja template and the filesystem. Detection inaccuracy is explicitly out of scope, since the README already states it is unvalidated. There is also a note asking people to report it as a design defect if the tool ever makes covert recording easier.
CODE_OF_CONDUCT.md is Contributor Covenant 2.1 with a working contact route.
README now opens the demo section with the hosted report, so a visitor sees the deliverable before deciding whether to install anything.
71 tests pass; CI runs them on 3.11 and 3.12.
🤖 Generated with Claude Code