chore: import upstream snapshot with attribution
CodeQL / Analyze (javascript-typescript) (push) Waiting to run
Docs / Validate docs (push) Waiting to run
CodeQL / Analyze (actions) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
Sync skills to ClawHub / Publish changed skills (push) Waiting to run
regression / regression-shards (style-16-prod style-9-prod style-17-prod iframe-render-compat variables-prod mp4-h265-sdr, shard-4) (push) Has been cancelled
regression / regression-shards (style-4-prod style-11-prod style-2-prod animejs-adapter typegpu-adapter parallel-capture-regression, shard-5) (push) Has been cancelled
regression / regression-shards (style-7-prod style-8-prod style-10-prod css-spinner-render-compat webm-transparency mp4-h264-sdr webm-vp9, shard-3) (push) Has been cancelled
regression / regression-shards (sub-composition-video style-18-prod raf-ball-render-compat font-variant-numeric sub-comp-t0 sub-comp-id-selector, shard-7) (push) Has been cancelled
Windows render verification / Detect changes (push) Has been cancelled
Windows render verification / Preflight (lint + format) (push) Has been cancelled
Windows render verification / Render on windows-latest (push) Has been cancelled
Windows render verification / Tests on windows-latest (push) Has been cancelled
CI / Detect changes (push) Has been cancelled
CI / Build (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Fallow audit (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Typecheck (push) Has been cancelled
CI / Test (push) Has been cancelled
CI / Producer: integration tests (push) Has been cancelled
CI / Producer: unit tests (push) Has been cancelled
CI / File size check (push) Has been cancelled
CI / Test: skills (push) Has been cancelled
CI / Skills: manifest in sync (push) Has been cancelled
CI / CLI: npx shim (macos-latest) (push) Has been cancelled
CI / CLI: npx shim (ubuntu-latest) (push) Has been cancelled
CI / CLI: npx shim (windows-latest) (push) Has been cancelled
CI / SDK: unit + contract + smoke (push) Has been cancelled
CI / Test: runtime contract (push) Has been cancelled
CI / Studio: load smoke (push) Has been cancelled
CI / Smoke: global install (push) Has been cancelled
CI / CLI smoke (required) (push) Has been cancelled
CI / Semantic PR title (push) Has been cancelled
Player perf / Detect changes (push) Has been cancelled
Player perf / Preflight (lint + format) (push) Has been cancelled
Player perf / player-perf (push) Has been cancelled
Player perf / Perf: drift (push) Has been cancelled
Player perf / Perf: fps (push) Has been cancelled
Player perf / Perf: parity (push) Has been cancelled
Player perf / Perf: scrub (push) Has been cancelled
Player perf / Perf: load (push) Has been cancelled
preview-regression / Detect changes (push) Has been cancelled
preview-regression / Preflight (lint + format) (push) Has been cancelled
preview-regression / Preview parity (push) Has been cancelled
preview-regression / preview-regression (push) Has been cancelled
regression / regression (push) Has been cancelled
regression / Detect changes (push) Has been cancelled
regression / Preflight (lint + format) (push) Has been cancelled
regression / regression-shards (hdr-regression style-5-prod style-3-prod mov-prores, shard-1) (push) Has been cancelled
regression / regression-shards (overlay-montage-prod style-12-prod chat missing-host-comp-id png-sequence portrait-edge-bleed, shard-6) (push) Has been cancelled
regression / regression-shards (style-13-prod style-6-prod vignelli-stacking gsap-letters-render-compat audio-mux-parity, shard-8) (push) Has been cancelled
regression / regression-shards (style-15-prod hdr-hlg-regression style-1-prod many-cuts vfr-screen-recording render-symlinked-assets, shard-2) (push) Has been cancelled
CodeQL / Analyze (javascript-typescript) (push) Waiting to run
Docs / Validate docs (push) Waiting to run
CodeQL / Analyze (actions) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
Sync skills to ClawHub / Publish changed skills (push) Waiting to run
regression / regression-shards (style-16-prod style-9-prod style-17-prod iframe-render-compat variables-prod mp4-h265-sdr, shard-4) (push) Has been cancelled
regression / regression-shards (style-4-prod style-11-prod style-2-prod animejs-adapter typegpu-adapter parallel-capture-regression, shard-5) (push) Has been cancelled
regression / regression-shards (style-7-prod style-8-prod style-10-prod css-spinner-render-compat webm-transparency mp4-h264-sdr webm-vp9, shard-3) (push) Has been cancelled
regression / regression-shards (sub-composition-video style-18-prod raf-ball-render-compat font-variant-numeric sub-comp-t0 sub-comp-id-selector, shard-7) (push) Has been cancelled
Windows render verification / Detect changes (push) Has been cancelled
Windows render verification / Preflight (lint + format) (push) Has been cancelled
Windows render verification / Render on windows-latest (push) Has been cancelled
Windows render verification / Tests on windows-latest (push) Has been cancelled
CI / Detect changes (push) Has been cancelled
CI / Build (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Fallow audit (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Typecheck (push) Has been cancelled
CI / Test (push) Has been cancelled
CI / Producer: integration tests (push) Has been cancelled
CI / Producer: unit tests (push) Has been cancelled
CI / File size check (push) Has been cancelled
CI / Test: skills (push) Has been cancelled
CI / Skills: manifest in sync (push) Has been cancelled
CI / CLI: npx shim (macos-latest) (push) Has been cancelled
CI / CLI: npx shim (ubuntu-latest) (push) Has been cancelled
CI / CLI: npx shim (windows-latest) (push) Has been cancelled
CI / SDK: unit + contract + smoke (push) Has been cancelled
CI / Test: runtime contract (push) Has been cancelled
CI / Studio: load smoke (push) Has been cancelled
CI / Smoke: global install (push) Has been cancelled
CI / CLI smoke (required) (push) Has been cancelled
CI / Semantic PR title (push) Has been cancelled
Player perf / Detect changes (push) Has been cancelled
Player perf / Preflight (lint + format) (push) Has been cancelled
Player perf / player-perf (push) Has been cancelled
Player perf / Perf: drift (push) Has been cancelled
Player perf / Perf: fps (push) Has been cancelled
Player perf / Perf: parity (push) Has been cancelled
Player perf / Perf: scrub (push) Has been cancelled
Player perf / Perf: load (push) Has been cancelled
preview-regression / Detect changes (push) Has been cancelled
preview-regression / Preflight (lint + format) (push) Has been cancelled
preview-regression / Preview parity (push) Has been cancelled
preview-regression / preview-regression (push) Has been cancelled
regression / regression (push) Has been cancelled
regression / Detect changes (push) Has been cancelled
regression / Preflight (lint + format) (push) Has been cancelled
regression / regression-shards (hdr-regression style-5-prod style-3-prod mov-prores, shard-1) (push) Has been cancelled
regression / regression-shards (overlay-montage-prod style-12-prod chat missing-host-comp-id png-sequence portrait-edge-bleed, shard-6) (push) Has been cancelled
regression / regression-shards (style-13-prod style-6-prod vignelli-stacking gsap-letters-render-compat audio-mux-parity, shard-8) (push) Has been cancelled
regression / regression-shards (style-15-prod hdr-hlg-regression style-1-prod many-cuts vfr-screen-recording render-symlinked-assets, shard-2) (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,168 @@
|
||||
---
|
||||
title: Contributing
|
||||
description: "How to contribute to Hyperframes."
|
||||
---
|
||||
|
||||
Thanks for your interest in contributing to Hyperframes! This guide covers everything you need to get set up, run tests, and submit a pull request.
|
||||
|
||||
## Getting Started
|
||||
|
||||
<Steps>
|
||||
<Step title="Fork and clone">
|
||||
Fork the repository on GitHub, then clone your fork:
|
||||
```bash
|
||||
git clone https://github.com/YOUR_USERNAME/hyperframes.git
|
||||
cd hyperframes
|
||||
```
|
||||
</Step>
|
||||
<Step title="Install dependencies">
|
||||
Hyperframes uses [bun](https://bun.sh/) for package management:
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
</Step>
|
||||
<Step title="Build all packages">
|
||||
Build the monorepo to ensure everything compiles:
|
||||
```bash
|
||||
bun run build
|
||||
```
|
||||
</Step>
|
||||
<Step title="Run the studio">
|
||||
Start the development server to verify your setup:
|
||||
```bash
|
||||
bun run dev
|
||||
```
|
||||
If the studio opens at `http://localhost:3000` with a preview, your environment is ready.
|
||||
</Step>
|
||||
<Step title="Create a branch">
|
||||
Create a feature branch for your work:
|
||||
```bash
|
||||
git checkout -b my-feature
|
||||
```
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Development
|
||||
|
||||
### Common Commands
|
||||
|
||||
```bash
|
||||
bun install # Install all dependencies
|
||||
bun run dev # Start the studio (composition editor + live preview)
|
||||
bun run build # Build all packages
|
||||
bun run --filter '*' typecheck # Type-check all packages
|
||||
```
|
||||
|
||||
### Studio Editing Work
|
||||
|
||||
If you are changing Studio's visual editing surface, read
|
||||
[Studio Manual DOM Editing](/contributing/studio-manual-dom-editing) before
|
||||
editing code. The inspector intentionally exposes only interactions it can
|
||||
persist safely back to HTML, so changes should preserve the capability gates,
|
||||
source patching model, and documented limitations.
|
||||
|
||||
### Running Tests
|
||||
|
||||
<CodeGroup>
|
||||
```bash Core
|
||||
bun run --filter @hyperframes/core test
|
||||
```
|
||||
```bash Engine
|
||||
bun run --filter @hyperframes/engine test
|
||||
```
|
||||
```bash Runtime Contract
|
||||
bun run --filter @hyperframes/core test:hyperframe-runtime-ci
|
||||
```
|
||||
```bash Producer (Docker)
|
||||
cd packages/producer && bun run docker:build:test && bun run docker:test
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Running All Tests
|
||||
|
||||
```bash
|
||||
bun run --filter '*' test
|
||||
```
|
||||
|
||||
## Packages
|
||||
|
||||
| Package | Path | Description |
|
||||
|---------|------|-------------|
|
||||
| [`@hyperframes/core`](/packages/core) | `packages/core` | Types, HTML generation, runtime, linter |
|
||||
| [`@hyperframes/sdk`](/packages/sdk) | `packages/sdk` | Headless composition editing engine |
|
||||
| [`@hyperframes/engine`](/packages/engine) | `packages/engine` | Seekable page-to-video capture engine |
|
||||
| [`@hyperframes/player`](/packages/player) | `packages/player` | Embeddable composition player |
|
||||
| [`@hyperframes/producer`](/packages/producer) | `packages/producer` | Full rendering pipeline (capture + encode) |
|
||||
| [`@hyperframes/shader-transitions`](/packages/shader-transitions) | `packages/shader-transitions` | WebGL shader transition engine |
|
||||
| [`@hyperframes/aws-lambda`](/packages/aws-lambda) | `packages/aws-lambda` | AWS Lambda distributed rendering adapter |
|
||||
| [`@hyperframes/gcp-cloud-run`](/packages/gcp-cloud-run) | `packages/gcp-cloud-run` | GCP Cloud Run distributed rendering adapter |
|
||||
| [`@hyperframes/studio`](/packages/studio) | `packages/studio` | Composition editor UI |
|
||||
| [`hyperframes`](/packages/cli) | `packages/cli` | CLI for creating, previewing, and rendering |
|
||||
| `@hyperframes/sdk-playground` (private) | `packages/sdk-playground` | Local SDK playground app |
|
||||
|
||||
## What to Work On
|
||||
|
||||
Not sure where to start? Here are some ideas:
|
||||
|
||||
- **Good first issues** — look for issues labeled `good first issue` on GitHub
|
||||
- **Documentation** — improve docs, add examples, fix typos
|
||||
- **Linter rules** — add new rules to catch more composition mistakes
|
||||
- **Examples** — create new starter examples
|
||||
- **Bug fixes** — check the issue tracker for reported bugs
|
||||
|
||||
## Pull Requests
|
||||
|
||||
### Commit Format
|
||||
|
||||
Use [conventional commit](https://www.conventionalcommits.org/) format for all commits and PR titles:
|
||||
|
||||
```
|
||||
feat: add timeline export
|
||||
fix: resolve seek overflow at composition boundary
|
||||
docs: add GSAP easing examples
|
||||
refactor: extract frame buffer pool into shared module
|
||||
test: add regression test for nested composition timing
|
||||
```
|
||||
|
||||
### CI Requirements
|
||||
|
||||
All of the following must pass before your PR can be merged:
|
||||
|
||||
- **Build** — `bun run build` succeeds
|
||||
- **Type check** — `bun run --filter '*' typecheck` reports no errors
|
||||
- **Tests** — all test suites pass
|
||||
- **Semantic PR title** — PR title follows conventional commit format
|
||||
|
||||
### Review Process
|
||||
|
||||
- PRs require at least 1 approval from a maintainer
|
||||
- Keep PRs focused — one feature or fix per PR
|
||||
- Target alpha-only PRs at `next` instead of `main`; see
|
||||
[Release channels](/contributing/release-channels) for branch policy details
|
||||
- Include a clear description of what changed and why
|
||||
- Add tests for new features and bug fixes
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
- Use [GitHub Issues](https://github.com/heygen-com/hyperframes/issues) for bug reports and feature requests
|
||||
- Search existing issues before creating a new one
|
||||
- For bug reports, include:
|
||||
- Steps to reproduce
|
||||
- Expected behavior vs. actual behavior
|
||||
- Hyperframes version (`npx hyperframes info`)
|
||||
- Operating system and Node.js version
|
||||
|
||||
## Community
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="GitHub Issues" icon="github" href="https://github.com/heygen-com/hyperframes/issues">
|
||||
Report bugs, request features, and discuss ideas.
|
||||
</Card>
|
||||
<Card title="Code of Conduct" icon="handshake" href="https://github.com/heygen-com/hyperframes/blob/main/CODE_OF_CONDUCT.md">
|
||||
Our community standards and expectations.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under the [Apache 2.0 License](https://github.com/heygen-com/hyperframes/blob/main/LICENSE).
|
||||
Reference in New Issue
Block a user