Skip to content

chore: prep repo for public release - #56

Merged
mariuspruvot merged 1 commit into
mainfrom
chore/public-release-cleanup
May 28, 2026
Merged

chore: prep repo for public release#56
mariuspruvot merged 1 commit into
mainfrom
chore/public-release-cleanup

Conversation

@mariuspruvot

Copy link
Copy Markdown
Owner

Summary

  • Ignore internal redesign artifacts (redisign/, docs/frontend-redesign.md, scripts/qa-frontend-agent.md) so they stop showing up in git status and can't be accidentally pushed.
  • Annotate the test-only FERNET_KEY in .github/workflows/ci.yml to make clear it is a throwaway used by the ephemeral CI database only.
  • Add a hardware sizing table to docs/self-hosting.md (minimum / recommended / comfortable, with per-runner footprint).
  • Add SECURITY.md pointing to GitHub's private vulnerability reporting, with operator responsibilities spelled out.
  • Add issue templates (bug_report, feature_request) and a config.yml that redirects security questions to the advisory form and self-hosting questions to the docs.
  • README: add MIT + alpha status badges, an explicit Status section, a BYOK cost line, and a link to SECURITY.md.

Why

Punch list before flipping the repo to public. Closes the obvious gaps: no dirty untracked files, no scary-looking test key without context, clear hardware expectations for self-hosters, a documented vulnerability reporting path, and structured intake for issues.

Notes

  • Stale remote branches (merged into main) are still on GitHub — left intact, can be pruned manually with the GitHub UI or gh api -X DELETE.
  • feat/dashboard-activity-chart-impl is the only local branch with unmerged work and was kept.

Test plan

  • CI green
  • git status clean on a fresh main checkout (no redisign/ / frontend-redesign.md / qa-frontend-agent.md showing)
  • Issue template picker appears on the New Issue page
  • Security advisory link in config.yml resolves

- ignore internal redesign artifacts (redisign/, frontend-redesign.md, qa-frontend-agent.md)
- annotate test-only FERNET_KEY in CI workflow
- add hardware sizing table to self-hosting guide
- add SECURITY.md (private vulnerability reporting via GitHub advisories)
- add issue templates (bug, feature) + config redirecting security and setup questions
- README: MIT/status badges, alpha status section, BYOK cost note, link to SECURITY.md
@helprs-prod

helprs-prod Bot commented May 28, 2026

Copy link
Copy Markdown

helPRs session created for this PR.

Skill: challenge-me | Open session

@mariuspruvot
mariuspruvot merged commit c3516d2 into main May 28, 2026
10 checks passed
@mariuspruvot
mariuspruvot deleted the chore/public-release-cleanup branch July 30, 2026 16:16
mariuspruvot added a commit that referenced this pull request Jul 30, 2026
- ignore internal redesign artifacts (redisign/, frontend-redesign.md, qa-frontend-agent.md)
- annotate test-only FERNET_KEY in CI workflow
- add hardware sizing table to self-hosting guide
- add SECURITY.md (private vulnerability reporting via GitHub advisories)
- add issue templates (bug, feature) + config redirecting security and setup questions
- README: MIT/status badges, alpha status section, BYOK cost note, link to SECURITY.md
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