[EVI-12]: prepare public repo hygiene#42
Conversation
EVI-12 Prepare evidence for impeccable public repo hygiene
Context / backgroundThe This issue prepares the repository for public visibility. The actual GitHub visibility flip is a human gate and is not part of the implementation PR. Acceptance criteria
External validation gates
Out of scope
Inputs / dependenciesTarget repository: Known audit findings to address:
Required verification commands: actionlint .github/workflows/*.yml Examples/workflows/*.yml
swift test
swift run evidence -- --helpSuggested hygiene scan approaches: git ls-files | xargs rg -n "AKIA|SECRET|TOKEN|PASSWORD|PRIVATE KEY|aws_access_key|aws_secret|self-hosted|/Users/|riddim-agent|RIDDIM_RELEASE_TOKEN"Add or refine patterns as needed. If a match is expected documentation, leave it only when the surrounding text makes clear it is an example or placeholder. Risks / notes for implementerTreat public repo safety as the product. The goal is not merely to avoid leaking secrets; the repo should look intentional, trustworthy, and easy for another builder to clone, test, and understand. Do not remove useful docs just to reduce work unless they are stale enough to mislead users. Prefer small, accurate public docs over broad claims. Workflow safety is the highest-risk area. Public repositories must not run untrusted fork PR code on Riddim self-hosted runners. If a workflow requires credentials or internal infrastructure, make it Definition of DoneDone when the repo has license hygiene, public-safe workflows, accurate public documentation, reviewed examples, no accidental internal operational files, documented secret/internal-context scan results, passing workflow lint, passing Swift tests, and CLI docs aligned with Architecture ImpactDocs, CI, and repository hygiene only. No intended changes to Evidence domain behavior or artifact semantics. Workflow changes affect public contributor safety and CI trust boundaries. Clean Architecture ShapeN/A — this issue prepares repository hygiene and public documentation; it does not change application behavior. Mergeability / change ownershipSingle reason to change: make |
|
Symphony developer-bot lease marker. Do not edit; managed by the autonomous loop. |
## Summary - Cuts the root README from 375 lines / 1,765 words to 161 lines / 565 words. - Keeps the README focused on purpose, quick start, minimal app usage, command overview, one CI example, safety guidance, and links. - Leaves detailed command and launch material in `docs/` and `Examples/` instead of duplicating it in the root README. ## Review basis Sampled GitHub's README guidance plus public README patterns from React, VS Code, freeCodeCamp, and Oh My Zsh. The applied pattern is: short front door, quick path to first use, links to deeper docs. ## Verification - `wc -l README.md && wc -w README.md` -> 161 lines, 565 words. - `swift run evidence -- --help` passed and README command references match the exposed CLI surface. - `git diff --check origin/main..HEAD` passed. - README stale/internal scan returned no matches for removed commands, internal runner labels, local paths, or private Riddim repo references. - `swift test --filter WorkflowSafetyTests` passed: 3 tests, 0 failures. Follow-up to EVI-12 / PR #42. Co-authored-by: Sunny Purewal <sunny@riddimsoftware.com>
Summary
Verification
actionlint .github/workflows/*.yml Examples/workflows/*.ymlpassed.swift testpassed: 126 tests executed, 2 skipped, 0 failures.swift run evidence -- --helppassed and listscapture-screenshots,resize,render-marketing,record-preview,capture-evidence,upload-screenshots,capture-web, andcapture-pr.swift run evidence -- capture-pr --helppassed and matches the README/launch demo references.git diff --checkpassed.test ! -e WORKFLOW.mdpassed.Hygiene scan
Exact internal-signal scan command:
Result: no matches after staging the deletion of
.github/workflows/set-automerge.yml.Canonical token-name audit:
Result: 28 references, all expected GitHub Actions token wiring, examples, docs, or validator tests. No private token values are present.
External validation gates
Fixes EVI-12.