Launch-ready: README hero, community files, examples, release automation#10
Merged
Conversation
The repo content was solid but the surface was undersold. This PR fixes that without touching any runtime code. README - Hero rewritten: badges (CI / PyPI / license / star), centered, with a one-line value prop and bullet list of what is in the box - Pyproject description updated (was still talking about wiki PDFs) - Star History chart embed at the bottom + clearer asks for stars - Community section now points to Discussions, ROADMAP, CONTRIBUTING, SECURITY explicitly GitHub community files (.github/) - ISSUE_TEMPLATE/ with three issue forms (bug, feature, integration) and a config.yml that points security reports to SECURITY.md - PULL_REQUEST_TEMPLATE.md - FUNDING.yml (github sponsorship) Project files (root) - CONTRIBUTING.md contributor onboarding (clone, install, CI, where things go, how to add an integration) - CODE_OF_CONDUCT.md Contributor Covenant 2.1, short version up top - SECURITY.md coordinated disclosure path, scope, supported versions - CHANGELOG.md Keep-a-Changelog format, 0.1.0 to 0.2.1 documented - ROADMAP.md what is next, with reasoning, ordered Now/Next/Later Examples (examples/) - 5 new runnable scripts: openai/anthropic quickstart, decorators, eval, budget. Each <50 LOC, runnable in <30s. - examples/README.md indexes all of them with the OpenRouter free-tier path called out Release automation (.github/workflows/publish.yml) - Triggers on v* tag push - PyPI job uses Trusted Publishing (no token required once configured) - npm job for sdk-js, gated on NPM_TOKEN secret + version match against the tag Repo metadata (set via gh repo edit, separately from this commit) - description: "Open-source observability for LLM apps..." - homepage: github.com/OmkarRayAI/wiki-trace - 20 topics: llm, observability, tracing, evaluation, langchain, openai, anthropic, helicone, phoenix, weave, rag, agents, python, typescript, self-hosted, open-source, monitoring, opentelemetry, ai, llmops Launch playbook (docs/LAUNCH.md) - Pre-launch checks - Hacker News / ProductHunt / X / Reddit copy-paste templates - Newsletter pitch list - Realistic star expectations the maintainer cannot post on behalf of the user; this file is the actual content for them to use Verified: pytest -q tests/ -> 88 passed, 14 skipped, no regressions. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Launch-ready polish — turns the repo from "fine for a side-project" to "looks serious enough to actually try". Zero runtime code changes.
What
README hero rewrite — badges (CI / PyPI / license / star), centered layout, one-line value prop + bulleted what's-in-the-box. Star History chart embed + clearer asks for stars at the bottom.
GitHub community files — three issue templates (bug, feature, integration), PR template, FUNDING.yml.
Project root files —
CONTRIBUTING.md,CODE_OF_CONDUCT.md,SECURITY.md,CHANGELOG.md(0.1.0 → 0.2.1 documented),ROADMAP.md.5 runnable examples —
examples/openai_quickstart.py,anthropic_quickstart.py,decorators_quickstart.py,eval_quickstart.py,budget_quickstart.py. Each <50 LOC, runs in <30s. The OpenAI example auto-detectsOPENROUTER_API_KEYfor the free-tier path.Release automation —
.github/workflows/publish.ymltriggers onv*tag push. PyPI via Trusted Publishing, npm forsdk-jsgated onNPM_TOKEN+ version match.Launch playbook —
docs/LAUNCH.mdhas copy-paste-ready posts for HN, ProductHunt, X thread, Reddit, plus newsletter pitch templates and honest expectations (1k stars achievable in a month, 100k a year is moonshot territory).Repo metadata (set separately via
gh repo edit, outside this PR): description rewritten, homepage set, 20 topics added (llm, observability, tracing, langchain, openai, anthropic, helicone, phoenix, weave, etc.).Test plan
git tag v0.2.1 && git push origin v0.2.1) to trigger the publish workflow once PyPI Trusted Publishing is configureddocs/LAUNCH.mdto post HN / PH / X🤖 Generated with Claude Code