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
98Tenant stores stay private. Making ` uinaf/fincrawl ` public does not make any
109tenant credentials, tenant config, encrypted snapshots, plaintext scratch data,
1110logs, 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
103102source checkout token for ` uinaf/fincrawl ` , but tenant provider credentials and
104103artifact 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
118110gh 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