Skip to content

chore: prepare the repository for a public release - #70

Merged
vishr merged 1 commit into
mainfrom
chore/public-release-hygiene
Aug 18, 2026
Merged

chore: prepare the repository for a public release#70
vishr merged 1 commit into
mainfrom
chore/public-release-hygiene

Conversation

@vishr

@vishr vishr commented Aug 18, 2026

Copy link
Copy Markdown
Member

Two things a stranger's tooling sees before they read any code.

Secret scan

gitleaks reports 12 findings. All 12 are redaction-test fixtures — strings invented to look exactly like leaked credentials, asserted never to reach output, so a real leak fails the test rather than passing unnoticed.

File State Findings
internal/compose/redact_test.go present 2 in working tree, 4 in history
internal/onebox/memory_test.go deleted in 7ad7671 8 in history, blobs still reachable

Nothing is wrong. But leaks found: 12 is what anyone pointing a scanner at this repo sees first, and explaining it twelve times is worse than listing it once.

.gitleaksignore lists them by fingerprint, not by path, so it cannot quietly widen into a blanket exemption — a genuine secret added to either file later produces a new fingerprint and is still reported.

working tree:  no leaks found
full history:  no leaks found

Code of conduct

CONTRIBUTING.md had a code-of-conduct section with no CODE_OF_CONDUCT.md beside it — which is what GitHub's community-standards check and most contributors look for.

The file now exists carrying the same standard in the same words, rather than a second one that can drift from the first, plus how to report conduct and what enforcement means. CONTRIBUTING.md links to it instead of restating it.

Verified

just check passes. Both gitleaks scan modes clean.

Part of open-source readiness; the remaining blocker is #58.

Two things a stranger's tooling sees before they read any code.

A secret scan of this repository reports twelve findings. All twelve are
redaction-test fixtures: strings invented to look exactly like leaked
credentials, asserted never to reach output, so that a real leak fails the test
rather than passing unnoticed. Two are in internal/compose/redact_test.go today;
ten are in internal/onebox/memory_test.go, which was deleted in 7ad7671 but
stays reachable in history.

Nothing is wrong, but "twelve leaks found" is what anyone pointing a scanner at
this repository will see first, and explaining that twelve times is worse than
listing them once. .gitleaksignore lists them by fingerprint rather than by
path, so it cannot quietly widen: a genuine secret added to either file later
produces a new fingerprint and is still reported. Both scan modes are now clean.

CONTRIBUTING.md carried a code of conduct with no CODE_OF_CONDUCT.md beside it,
which GitHub's community-standards check looks for and contributors look for.
The file now exists, carrying the same standard in the same words rather than a
second one that can drift, plus how to report conduct and what enforcement
means. CONTRIBUTING links to it instead of restating it.

`just check` passes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@vishr
vishr merged commit 67afad3 into main Aug 18, 2026
5 checks passed
vishr added a commit that referenced this pull request Aug 18, 2026
chore: prepare the repository for a public release
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant