Skip to content

chore: public-repo polish (community files, as-built docs) - #29

Merged
kraenhansen merged 6 commits into
mainfrom
chore/public-repo-polish
Oct 26, 2026
Merged

kraenhansen merged 6 commits into
mainfrom
chore/public-repo-polish

Conversation

@kraenhansen

@kraenhansen kraenhansen commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Now that the repo is public, outside contributors need issue/PR templates, a security policy and docs that match the shipped SDK. Closes #20 and covers the docs/metadata part of #12 (new samples stay in #26, landing media in #19).

Changes

  • Add issue forms (bug, feature, contact links), a PR template, CODEOWNERS and SECURITY.md under .github/, plus Support and License sections in the README.
  • Rewrite the CHANGELOG 0.1.0 entry to the API that actually shipped, with the Unity 6.3 minimum folded in.
  • Update ARCHITECTURE.md, CONTRIBUTING.md (adds "Submitting changes") and COMPATIBILITY.md to the as-built native transport, asmdef layout, test layers and builds, and limit platform claims to what's tested.
  • Fix a stale "native impl in v0.2" error message and a broken EndSessionAsync cref.
  • Run the Unity CI lanes on fork PRs only after a maintainer approves the fork-ci environment (fork pull_request runs never get the UNITY_* secrets); same-repo PRs and pushes keep running unattended.

Verification

  • dotnet csharpier check .
  • Bridge~ checks (format:check, lint, typecheck, test, verify:primitives, verify:connection)
  • Codegen~ checks (verify:protocol-dtos, round-trip)
  • Edit Mode tests (pnpm --dir TestProject run test)
  • WebGL builds + browser integration tests (IntegrationTests~)
  • Manually tested in a Unity project. Platforms and Unity version:

Checklist

  • CHANGELOG.md updated under [Unreleased] for user-facing changes
  • Public API changes are called out above

Additional context intended for coding agents and bots

Design notes

  • SECURITY.md lives in .github/ (GitHub reads it there) so Unity doesn't import it into the package or need a .meta. It points at GitHub private vulnerability reporting (already enabled) and the ElevenLabs VDP from elevenlabs.io/.well-known/security.txt.
  • Issue forms are modelled on elevenlabs/elevenlabs-python (the only DX SDK repo with templates), adapted for Unity version, build target and Editor/Player/browser logs. No sibling DX repo has a PR template, CODEOWNERS or a usable security policy to copy.
  • CODEOWNERS is * @kraenhansen.
  • The CHANGELOG change rewrites the 0.1.0 entry itself rather than adding an [Unreleased] line, since 0.1.0 has never been tagged; that's why the "CHANGELOG updated under [Unreleased]" box is unticked.
  • Fork CI: jobs choose their path by event and head repo. Same-repo PRs use pull_request; fork PRs use pull_request_target with environment: fork-ci (required reviewer @kraenhansen, already created), checking out pull_request.head.sha with persist-credentials: false. Runs inside forks are skipped. Fork runs restore but never save caches, since pull_request_target caches land in main's scope. Concurrency groups include event + PR number, because github.ref is main under pull_request_target. pull_request_target uses the workflow from main, so the fork path takes effect after merge.
  • Platform claims: only Editor, desktop standalone (HostBuild.BuildStandalone) and WebGL are built or tested, so iOS/Android/XR are listed as untested; native WebRTC is documented as unsupported (NotSupportedException).

Known follow-ups (not in this PR)

  • .github/workflows/lint.yml's header comment references a nonexistent Docs~/plans/ci.md and says the Unity lanes are blocked on licensing.
  • The repo lacks the DX team's shared triage labels (needs reproduction, has reproduction, needs information, tracking, confirmed, upstream, stale) used by sibling SDK repos.

Test plan and verification

  • unity test TestProject --mode EditMode -- -nographics: 460/460 passed.
  • dotnet csharpier check Runtime: clean.
  • Prettier check on .github/ and README.md (parses the issue-form YAML): clean.
  • Every API name in the CHANGELOG matched against public members of Conversation / ConversationOptions; doc claims cross-checked against code by a read-only audit pass.
  • Support links (discord.com/invite/elevenlabs, ElevenAgents docs, elevenlabs.io/security/report) return 200.

🤖 Generated with Claude Code

@kraenhansen kraenhansen self-assigned this Oct 2, 2026
@kraenhansen
kraenhansen requested a review from PaulAsjes October 26, 2026 10:20
@kraenhansen
kraenhansen marked this pull request as ready for review October 26, 2026 10:21
@kraenhansen
kraenhansen enabled auto-merge (squash) October 26, 2026 10:28
@kraenhansen
kraenhansen disabled auto-merge October 26, 2026 10:42
kraenhansen and others added 6 commits October 26, 2026 11:42
Issue forms, PR template, CODEOWNERS and SECURITY.md (under .github/ so
Unity doesn't import them), plus Support and License sections in the
README. Templates follow elevenlabs-python's issue forms, adapted for
Unity versions, build targets and logs.

Closes #20

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
CHANGELOG 0.1.0 lists the API that actually exists, and folds in the
Unity 6.3 minimum (never released at 6000.0). ARCHITECTURE, CONTRIBUTING
and COMPATIBILITY describe the shipped native transport, asmdef layout,
test layers and builds, and limit platform claims to what's tested.
CONTRIBUTING gains a "Submitting changes" section.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The missing-session-factory error named the native transport as a future
v0.2 addition, and OutputAudioSource's docs referenced a nonexistent
EndSessionAsync.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
GitHub withholds repo secrets from fork PRs, so game-ci's Unity
activation fails there. Skipping the Edit Mode and WebGL build jobs
(the integration job follows via `needs`) keeps outside contributors'
PRs from showing red checks; only the lint lane is a required check.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
GitHub withholds secrets from fork-triggered pull_request runs, even
after "Approve and run", so the Unity lanes can't activate there.
Same-repo PRs and pushes keep running unattended via pull_request.
Fork PRs run via pull_request_target, pinned to the PR head SHA, behind
the fork-ci environment's required reviewers. Runs inside forks are
skipped.

Fork runs execute untrusted editor code with license secrets, so they
also don't persist checkout credentials or save caches (caches written
under pull_request_target land in main's scope). Concurrency groups
include the event and PR number so fork runs don't cancel main's.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Removed caution note about early-stage SDK from README.
@kraenhansen
kraenhansen force-pushed the chore/public-repo-polish branch from 71139d4 to d9949c3 Compare October 26, 2026 10:42
@kraenhansen
kraenhansen enabled auto-merge (squash) October 26, 2026 10:42
@kraenhansen
kraenhansen merged commit 68ca33f into main Oct 26, 2026
5 checks passed
@kraenhansen
kraenhansen deleted the chore/public-repo-polish branch October 26, 2026 10:43
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.

Add .github/ public-repo polish (issue + PR templates, CODEOWNERS, SECURITY.md)

2 participants