mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-08-31 10:46:57 +00:00
ukimsanov
e94a458fed
Both P1s from Miguel's review on #2976. **The weekly changelog command has a fourth output, and it is public.** `changelog-process.mdx` listed three internal drafts. `outputWeeklyDraft` also calls `prependDocsUpdate` on `--write` (`scripts/changelog-weekly.ts:236`), which writes straight into `docs/weekly-updates.mdx`. A contributor following the page would review three files and push a fourth unread. Now called out as a warning, with the re-run behaviour, since that is what makes editing the entry afterwards safe. The same paragraph also said Weekly updates is "unlisted in the sidebar". That was true when written and I made it false myself, putting the page back under Explore in #2978 after Rames found it orphaned. Corrected rather than reverted — the page belongs in the sidebar. **Bare `hyperframes lint` cannot validate a registry item.** Both `contributing.mdx` and `contributing/catalog.mdx` told contributors to run it. The CLI resolves a project by looking for `index.html` (`packages/cli/src/utils/project.ts`), and registry items ship as `<name>.html` or `demo.html`, so it fails with "No composition found". This is not theoretical: `scripts/lint-registry-items.mjs` exists precisely for this shape and its header records two `gsap_non_transform_motion` errors that reached main unlinted because of it. Both pages now document `bun run lint:registry-items`, and the Catalog page shows the install-into-a-scratch-project route for the full `check` gate rather than claiming a bare `check` covers a registry item. Verified by running the documented command, not just by reading the script.
92 lines
3.4 KiB
Plaintext
92 lines
3.4 KiB
Plaintext
---
|
|
title: Contribute to HyperFrames
|
|
description: Set up the repository, make a focused change, and open a pull request.
|
|
---
|
|
|
|
## Set up the repository
|
|
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/hyperframes.git
|
|
cd hyperframes
|
|
bun install
|
|
bun run build
|
|
```
|
|
|
|
HyperFrames uses Bun for workspace operations. Do not add a `pnpm-lock.yaml` or replace `bun.lock`.
|
|
|
|
Start Studio while working on UI or composition behavior:
|
|
|
|
```bash
|
|
bun run dev
|
|
```
|
|
|
|
Studio listens on `http://localhost:5190` when run from the monorepo.
|
|
|
|
## Check your change
|
|
|
|
Run the smallest relevant test while iterating, then the repository gates before opening a pull request:
|
|
|
|
```bash
|
|
bun run lint
|
|
bun run format:check
|
|
bun run --filter '*' typecheck
|
|
bun run test
|
|
```
|
|
|
|
For a composition, run the gates from the project directory, or pass it:
|
|
|
|
```bash
|
|
npx hyperframes lint ./my-video
|
|
npx hyperframes check ./my-video
|
|
```
|
|
|
|
Registry items need a different command. They ship as `<name>.html` or
|
|
`demo.html`, and the CLI resolves a project by looking for `index.html`, so
|
|
pointing it at an item directory fails with "No composition found" — which is
|
|
how two `gsap_non_transform_motion` errors once reached `main` unlinted. Use the
|
|
script that mounts each item into a throwaway project first, exactly where
|
|
`hyperframes add` would put it:
|
|
|
|
```bash
|
|
bun run lint:registry-items # every item
|
|
bun run lint:registry-items my-block # just one
|
|
```
|
|
|
|
The pre-commit hooks format staged files and run checks for the files you changed.
|
|
|
|
## Work in the right package
|
|
|
|
| Surface | Package or directory |
|
|
| --- | --- |
|
|
| Composition parsing, runtime, types | `packages/core` and `packages/parsers` |
|
|
| Browser frame capture | `packages/engine` |
|
|
| Encoding and audio/render orchestration | `packages/producer` |
|
|
| Command line | `packages/cli` |
|
|
| Browser editor | `packages/studio` and `packages/studio-server` |
|
|
| Embeddable player | `packages/player` |
|
|
| Headless editing API | `packages/sdk` |
|
|
| AWS and GCP distributed rendering | `packages/aws-lambda` and `packages/gcp-cloud-run` |
|
|
| Reusable blocks and snippets | `registry` |
|
|
| Agent instructions | `skills` |
|
|
|
|
For Studio changes, verify the behavior in the browser and preserve the source-patching and capability-gate contracts described in the [Studio docs](/studio/index).
|
|
|
|
## Pull request requirements
|
|
|
|
- Keep the change focused and explain the user-visible reason for it.
|
|
- Add or update tests when behavior changes.
|
|
- Use a conventional PR title such as `fix: preserve audio after seeking`.
|
|
- Run formatting, lint, typecheck, and relevant tests.
|
|
- Include screenshots or a short capture for visual changes.
|
|
- Target prerelease-only work to the branch described in [Release channels](/contributing/release-channels).
|
|
|
|
Use [GitHub Issues](https://github.com/heygen-com/hyperframes/issues) for bugs and proposals. A useful bug report includes the smallest reproduction, the first exact error, `npx hyperframes info`, and the operating system.
|
|
|
|
By contributing, you agree that your work is licensed under the [Apache 2.0 License](https://github.com/heygen-com/hyperframes/blob/main/LICENSE) and follows the [Code of Conduct](https://github.com/heygen-com/hyperframes/blob/main/CODE_OF_CONDUCT.md).
|
|
|
|
## Related topics
|
|
|
|
- [Test local CLI changes](/contributing/testing-local-changes)
|
|
- [Contribute a Catalog item](/contributing/catalog)
|
|
- [Understand release channels](/contributing/release-channels)
|