Skip to content

Commit b1ca4c7

Browse files
committed
docs(security): add disclosure contact
1 parent 1eb4444 commit b1ca4c7

3 files changed

Lines changed: 20 additions & 29 deletions

File tree

SECURITY.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ screenshots.
77

88
## Reporting
99

10-
Use GitHub private vulnerability reporting. It must be enabled before this
11-
repository is made public. If private reporting is unexpectedly unavailable,
12-
open a minimal public issue asking for a private disclosure channel and include
13-
no exploit details, secrets, tenant identifiers, or transcript text.
10+
Please report vulnerabilities privately by emailing `dev@uinaf.dev`.
11+
12+
GitHub private vulnerability reporting is also enabled for this repository. If
13+
both private channels are unexpectedly unavailable, open a minimal public issue
14+
asking for a private disclosure channel and include no exploit details, secrets,
15+
tenant identifiers, or transcript text.
1416

1517
## Sensitive Data Rules
1618

docs/roadmap.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@ this repo.
2525

2626
## Next
2727

28-
- Choose a public license and complete the
29-
[open-source readiness](runbooks/open-source-readiness.md) checklist.
30-
- Enable or confirm private vulnerability reporting before public visibility.
3128
- Tighten local search result ranking and result fields from stored entity data.
3229
- Improve import/search ergonomics for read-only subscribers.
3330
- Add a small, generic tenant-store wrapper contract without committing tenant

docs/runbooks/open-source-readiness.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
# Open Source Readiness
22

3-
Status: active pre-publication checklist
3+
Status: active public-repository checklist
44

5-
`fincrawl` is designed to be public generic infrastructure. The reusable repo
6-
may be made public only after the checks below pass and an owner explicitly
7-
approves the visibility change.
5+
`fincrawl` is public generic infrastructure. Use this checklist before major
6+
public-facing changes, release pipeline changes, or any future history rewrite.
87

98
Tenant stores stay private. Making `uinaf/fincrawl` public does not make any
109
tenant credentials, tenant config, encrypted snapshots, plaintext scratch data,
1110
logs, reports, screenshots, summaries, or transcript-derived examples public.
1211

13-
## Blockers Before Public Visibility
12+
## Public Baseline
1413

15-
- Add an explicit `LICENSE` file. Until then, the repository is source-visible
16-
only to existing private collaborators and is not open for public reuse.
17-
- Enable or confirm a private security reporting path for the public repo.
18-
- Confirm the current tree, history, release pipeline, and docs contain no
14+
- `LICENSE` declares the public reuse terms.
15+
- `SECURITY.md` points reporters to `dev@uinaf.dev` and GitHub private
16+
vulnerability reporting.
17+
- The current tree, history, release pipeline, and docs should contain no
1918
tenant-derived residue.
20-
- Confirm the repository owner explicitly approves the visibility flip.
19+
- Repository metadata should stay aligned with the public CLI surface.
2120

2221
## Current Tree Audit
2322

@@ -89,7 +88,7 @@ visibility.
8988

9089
## Public Repo Metadata
9190

92-
Before flipping visibility, set public-facing metadata:
91+
Keep public-facing metadata aligned:
9392

9493
- Description: `Local-first support conversation archive CLI`
9594
- Topics: `intercom`, `support`, `archive`, `sqlite`, `age-encryption`,
@@ -103,23 +102,16 @@ After the repo is public, private tenant-store workflows may stop using a
103102
source checkout token for `uinaf/fincrawl`, but tenant provider credentials and
104103
artifact storage must remain private.
105104

106-
## Visibility Flip
105+
## Visibility Check
107106

108-
Only run the visibility change after the blockers are cleared and the owner has
109-
explicitly approved it in the current work session:
110-
111-
```bash
112-
gh repo edit uinaf/fincrawl --visibility public --accept-visibility-change-consequences
113-
```
114-
115-
Immediately after the flip, run:
107+
Confirm visibility and metadata with:
116108

117109
```bash
118110
gh repo view uinaf/fincrawl --json visibility,isPrivate,licenseInfo,securityPolicyUrl,repositoryTopics
119111
```
120112

121-
Then confirm the public release and CI surfaces still work without exposing
122-
tenant data:
113+
Confirm the public release and CI surfaces still work without exposing tenant
114+
data:
123115

124116
```bash
125117
./scripts/verify

0 commit comments

Comments
 (0)