docs: state the unofficial status, the real scan default, and the security route - #52
Merged
Merged
Conversation
…urity route The README described the max duration default as 10m. The form leaves it empty since the change that removed the cap, so the sentence now describes what the form does. The README also states plainly that this is an unofficial interface, and CONTRIBUTING points at SECURITY.md instead of describing a reporting channel that was never set up. SECURITY.md is new. It names GitHub private vulnerability reporting, states what is in scope, and says what a useful report contains. The CI triggers no longer list refactor/v2, which was deleted with the other merged branches.
![codescene-access[bot]](https://avatars.githubusercontent.com/in/3755875?s=60&v=4){kind=small}
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.
What changed
10m. That stopped being true when the form began leaving it empty, so it now says what the form does: no limit by default, with30s,10m,2hor0available.CONTRIBUTING.mdpointed at a private reporting channel that does not exist. It now points atSECURITY.md.SECURITY.mdis new. It names GitHub private vulnerability reporting as the route, states what is in and out of scope, and says what a useful report contains.ci.ymlno longer listsrefactor/v2, a branch that was deleted.Why
The repository is preparing to become public. Text that promises a channel nobody staffed is worse than no text, and a stale default is exactly the kind of claim a first reader catches in a minute.
Verification
''atfrontend/src/hooks/useScanForm.ts:32, the backend default is""atbackend/bumblebee_gui/models.py:26, and the catalogue section matches eleven catalogues with 1,072 entries at tagv0.1.2./host,/root/.bumblebee-gui/scans/...) and the demo fixture (/host/demo-app). No username, hostname or real home directory appears in any of them.Docs and CI triggers only, so no test changes. The five gates run on this pull request.