Skip to content

chore(growth): community health files, PyPI release workflow, social preview#31

Merged
Mrbaeksang merged 1 commit into
mainfrom
feat/growth-community-files
Jun 5, 2026
Merged

chore(growth): community health files, PyPI release workflow, social preview#31
Mrbaeksang merged 1 commit into
mainfrom
feat/growth-community-files

Conversation

@Mrbaeksang

Copy link
Copy Markdown
Owner

Researched what high-traffic OSS repos (ripgrep, FastAPI, crawl4ai, aider, ollama) put in their repo/README for growth, then filled DeepCloak's gaps. DeepCloak already had the Tier-1 conversion basics (install one-liner, hero tagline, badge row, About/topics, real demo GIF, comparison table, built-on credits) — this adds the missing repo-level pieces.

Added

  • Issue/PR templates (.github/ISSUE_TEMPLATE/* + PULL_REQUEST_TEMPLATE.md) — bug/feature forms using the domain glossary, with Discussions + security contact links.
  • SECURITY.md — private reporting (contact@baeksang.dev) + responsible-use scope (this tool Bypasses bot detection).
  • CODE_OF_CONDUCT.md — Contributor Covenant condensed.
  • .github/FUNDING.yml — Sponsor button → baeksang.dev.
  • CHANGELOG.md — Keep a Changelog, v0.1.0.
  • .github/workflows/release.yml — build + PyPI trusted-publish on GitHub Release. This is the critical one: deepcloak is not on PyPI yet, so pip install deepcloak currently fails. After a one-time PyPI Trusted-Publisher setup (noted in the workflow), publishing a release ships it automatically — no token.
  • pyproject: lean sdist — 18 KB (was 8.6 MB; dropped demo media + showcase from the sdist).
  • docs/media/og.png + showcase og:image / twitter card — social preview built from a real-run frame (the actual 🛡️ → bypassed lines), so shared links render a branded card instead of a gray box.

Still owner-only (can't do for you)

  • Configure the PyPI Trusted Publisher + publish v0.1.0.
  • Upload docs/media/og.png as the repo Settings → Social preview.
  • Enable Discussions; off-repo launch (Show HN, r/LocalLLaMA, r/webscraping, awesome-lists).

pytest 70 passed, ruff clean, build verified.

🤖 Generated with Claude Code

…preview

Fill the gaps a high-traffic OSS repo is expected to have (modeled on
ripgrep/FastAPI/crawl4ai/aider):

- .github/ISSUE_TEMPLATE (bug/feature + Discussions/security links) + PR template
- SECURITY.md (private reporting + responsible-use scope), CODE_OF_CONDUCT.md
- .github/FUNDING.yml (Sponsor button → baeksang.dev)
- CHANGELOG.md (Keep a Changelog, v0.1.0)
- .github/workflows/release.yml — build + PyPI trusted-publish on GitHub Release
  (so `pip install deepcloak` becomes true; one-time PyPI publisher setup noted)
- pyproject: lean sdist (18KB, was 8.6MB — drop demo media/showcase)
- docs/media/og.png + showcase og:image/twitter card — real-run social preview

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
deepcloak Ready Ready Preview, Comment Jun 5, 2026 1:41am

Request Review

@Mrbaeksang Mrbaeksang merged commit f95834c into main Jun 5, 2026
4 checks passed
@Mrbaeksang Mrbaeksang deleted the feat/growth-community-files branch June 5, 2026 01:41
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