Use this checklist before making the repository public.
- Rotate any credentials that were ever stored locally during development (API keys, SMTP tokens, DB passwords).
- Confirm
.envis not committed and remains git-ignored. - Confirm
.env.examplecontains placeholders only. - Run a final secret scan across the workspace.
- Verify no sensitive values exist in docs, screenshots, or replay artifacts.
- Keep generated runtime outputs out of commits (
simulations/artifacts/, logs, caches). - Keep only synthetic/non-client examples.
- Remove any private business or customer-only documents.
- Ensure root
README.mdis canonical andsignalforge/README.mdremains backend-scoped.
-
LICENSEis Apache-2.0. -
OPEN_SOURCE_POLICY.mdis present and accurate. -
CONTRIBUTING.mdis present and up to date. -
SECURITY.mdcontains a real reporting contact. -
CODEOWNERSreferences real GitHub usernames/teams.
- CI workflow exists and runs lint/tests.
- Local smoke check passes:
- Replay run (
python simulations/run_replay.py --shock-id shock-rate-50) - Key docs render cleanly in Markdown preview
- Replay run (
- No broken links in README/docs.
- README clearly states what SignalForge is and is not.
- README includes open-core scope and managed/commercial boundary.
- Disclaimer is present (not investment advice, no guaranteed outcomes).
- Validation evidence references are current (
simulations/validation/...).
If this folder is not yet a git repository:
git initgit add .git commit -m "Initial open-source release"- Create GitHub repo (empty) and copy its URL.
git branch -M maingit remote add origin <your-repo-url>git push -u origin main
If this is already a git repository:
git statusgit add .git commit -m "Prepare repository for open-source release"git push
- Enable GitHub Security Advisories.
- Enable Dependabot alerts and updates.
- Verify CI runs on the default branch.
- Create first release tag and changelog entry.
- Pin the best replay/validation docs in README for first-time visitors.