Skip to content

armgit / hypit

Public Imported from GitHub
0

Clone any viral video with AI agents. Not just a script, the whole workflow: swap the face, the words, the B-roll, ship 100 variants in one command, and get your 100M views.

docs: describe how to contribute

rpone117a3fe57004
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..02443d86
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,63 @@
+# Contributing to Hypit
+
+Pull requests are welcome. Documentation, examples and translations count as much as code.
+
+[简体中文](./CONTRIBUTING.zh-CN.md)
+
+## Before you start
+
+Pick up an [open issue](https://github.com/hypit-ai/hypit/issues) or open one describing what you
+want to work on. For anything that changes a protocol type, a package boundary or a Provider
+contract, describe the approach in the issue first — that discussion is cheaper than a rewritten
+pull request.
+
+By contributing you accept the terms in [LICENSE](./LICENSE) section 2: the producer may adjust the
+license, and contributed code may be used commercially, including in cloud business operations.
+
+## Set up
+
+You need Node.js 22+ and pnpm 10.33, selected by the root `packageManager` field.
+
+```bash
+corepack enable
+pnpm install --frozen-lockfile
+```
+
+Live Builds additionally need Python 3.10–3.13, uv, ffmpeg and Chromium. The
+[Development Guide](https://docs.hypit.ai/guide/develop) lists what each one is for.
+
+## Make the change
+
+| Where you are working | Guide |
+| --- | --- |
+| A new Author Package | [Adding an Author Package](https://docs.hypit.ai/guide/author-packages) |
+| A new Provider | [Adding a Provider](https://docs.hypit.ai/guide/providers) |
+| Component internals | [Component Anatomy](https://docs.hypit.ai/guide/component-anatomy) |
+| Compilation, Runs and Builds | [Runtime](https://docs.hypit.ai/guide/runtime) |
+| Naming, module boundaries, wire data | [Conventions](https://docs.hypit.ai/guide/conventions) |
+| Tests and environment-gated suites | [Testing](https://docs.hypit.ai/guide/testing) |
+
+English and Chinese documentation live side by side under `docs/` and `docs/zh/`. A change to one
+page belongs with the change to its counterpart.
+
+## Check your work
+
+CI runs these three commands on every pull request. Run them locally first:
+
+```bash
+pnpm check # TypeScript type-check
+pnpm test # package, service-adapter and repository-boundary tests
+pnpm test:release # repository hygiene
+```
+
+## Open the pull request
+
+Branch names and commit subjects share the same prefix: `feat/`, `fix/`, `docs/` for branches and
+`feat:`, `fix:`, `docs:` for commits. Write the subject in the imperative, and describe in the body
+what changed and why.
+
+Every change reaches `main` through a pull request.
+
+## Getting help
+
+Ask in [Discord](https://discord.gg/85hnyQnxpn) or [Telegram](https://t.me/hypit).
diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md
new file mode 100644
index 00000000..6b2f1c33
--- /dev/null
+++ b/CONTRIBUTING.zh-CN.md
@@ -0,0 +1,54 @@
+# 为 Hypit 做贡献
+
+欢迎提交 Pull Request。文档、示例和翻译与代码同样重要。
+
+[English](./CONTRIBUTING.md)
+
+## 开始之前
+
+可以认领一个[已有的 issue](https://github.com/hypit-ai/hypit/issues),也可以新开一个说明你想做的事。凡是会改动协议类型、包边界或 Provider 契约的改动,请先在 issue 里说明思路,这比重写一个 Pull Request 代价更低。
+
+提交贡献即表示你接受 [LICENSE](./LICENSE) 第 2 条:生产者可以调整该开源协议,你贡献的代码可用于商业用途,包括其云业务运营。
+
+## 环境准备
+
+需要 Node.js 22+ 和 pnpm 10.33,版本由根目录的 `packageManager` 字段指定。
+
+```bash
+corepack enable
+pnpm install --frozen-lockfile
+```
+
+运行真实 Build 还需要 Python 3.10–3.13、uv、ffmpeg 和 Chromium,各自的用途见[开发指南](https://docs.hypit.ai/zh/guide/develop)。
+
+## 进行改动
+
+| 改动范围 | 文档 |
+| --- | --- |
+| 新增 Author 包 | [添加 Author 包](https://docs.hypit.ai/zh/guide/author-packages) |
+| 新增 Provider | [添加 Provider](https://docs.hypit.ai/zh/guide/providers) |
+| 编译、Run 与 Build | [Runtime](https://docs.hypit.ai/zh/guide/runtime) |
+| 命名、模块边界、wire 数据 | [代码规范](https://docs.hypit.ai/zh/guide/conventions) |
+| 测试与依赖环境的测试套件 | [测试](https://docs.hypit.ai/zh/guide/testing) |
+
+中英文档分别位于 `docs/` 和 `docs/zh/`,改动一侧的页面时,请一并改动对应的另一侧。
+
+## 自查
+
+每个 Pull Request 的 CI 都会运行下面三条命令,提交前先在本地跑一遍:
+
+```bash
+pnpm check # TypeScript 类型检查
+pnpm test # 包、服务适配器与仓库边界测试
+pnpm test:release # 仓库卫生检查
+```
+
+## 提交 Pull Request
+
+分支名与提交信息使用同一套前缀:分支用 `feat/`、`fix/`、`docs/`,提交信息用 `feat:`、`fix:`、`docs:`。标题使用祈使句,正文说明改了什么以及为什么。
+
+所有改动都通过 Pull Request 进入 `main`。
+
+## 获取帮助
+
+在 [Discord](https://discord.gg/85hnyQnxpn) 或 [Telegram](https://t.me/hypit) 提问。
diff --git a/README.md b/README.md
index 443a82fd..9730c9be 100644
--- a/README.md
+++ b/README.md
@@ -128,6 +128,23 @@ Or start without a reference video:
Your agent can check the environment, request only the credentials the video needs, preview the result, and build it.
+## How to Contribute
+
+Pull requests are welcome, and documentation, examples and translations count as much as code. Pick
+up an open issue or open one for what you want to work on, and we will help you land it.
+[CONTRIBUTING.md](./CONTRIBUTING.md) has the setup, the checks CI runs and the pull request flow.
+
+The [Development Guide](https://docs.hypit.ai/guide/develop) covers the prerequisites, the daily
+commands and the repository layout. [Adding an Author Package](https://docs.hypit.ai/guide/author-packages)
+and [Adding a Provider](https://docs.hypit.ai/guide/providers) walk through the two most common
+contributions, and [Conventions](https://docs.hypit.ai/guide/conventions) states what a pull request
+is expected to follow.
+
+| Bug reports | Feature requests | Questions |
+| --- | --- | --- |
+| [Open an issue](https://github.com/hypit-ai/hypit/issues/new?labels=bug) | [Open an issue](https://github.com/hypit-ai/hypit/issues/new?labels=enhancement) | [Discord](https://discord.gg/85hnyQnxpn) or [Telegram](https://t.me/hypit) |
+| Something behaves differently than the docs describe | An idea for a new capability or an improvement | Ask about authoring, packages or providers |
+
## License
Hypit is released under the [Hypit Open Source License](./LICENSE). The videos and other outputs you create belong to you; third-party models and services may have their own terms.
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 2b0cf460..be9c6e4e 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -71,40 +71,40 @@ npx skills add hypit-ai/hypit -g
</tr>
</table>
-### 街头采访
+### 播客
<table>
<tr>
- <th>参考视频</th>
- <td></td>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
- <td></td>
+ <th width="16%">参考视频</th>
+ <td width="28%"></td>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/a1feb123-3129-4880-87d2-897c42026fff" controls muted></video></td>
+ <td width="28%"></td>
</tr>
<tr>
- <th>复刻视频</th>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
+ <th width="16%">复刻视频</th>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/d4bcb8a3-9ed5-46a8-900d-13891a83e6a0" controls muted></video></td>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/75cca3aa-d392-49a6-b0cd-9b1c3aff8f01" controls muted></video></td>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/2b04977e-665d-4d5f-8f82-c1ebdf567d2c" controls muted></video></td>
</tr>
<tr>
- <td colspan="4">本地部署的 MiniMax H3,3 次 GPT Image 2 生成;排行榜、TikTok 风格字幕和视觉特效由无头 Chromium 渲染。<b>总成本:$0.15。</b></td>
+ <td colspan="4"><p><b>“DAILY CREATINE”</b>——一条 18 秒的播客片段,肌肉芭比向一个瘦弱的大学生强推肌酸。A-roll 是 Seedance 2 Mini 生成的三段 720p 对峙镜头,外加一段展示理想生活方式的 B-roll;图像是 GPT Image 2 生成的两张 2K AI 角色肖像和三张 1K 蒙太奇画面。WhisperX 负责逐词对齐,再配上分屏访谈版式、区分说话人的卡拉 OK 字幕、产品递出的瞬间和背景音乐,最后由 64 个无头 Chromium 进程并发渲染。</p><p>上面给出了三个复刻版本:把两位主播换成 Pepe 和 Doge,争论狗狗手臂;把肌酸换成视黄醇,让漂亮男孩吐槽假小子的毛孔;把实体产品换成 CheatGPT 应用,让头脑简单的体育生绩点碾压博士生。同一套访谈形式,三个广告垂类。</p><p>总成本:<b>$1.07</b>。</p></td>
</tr>
</table>
-### 播客
+### 街头采访
<table>
<tr>
- <th>参考视频</th>
- <td></td>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
- <td></td>
+ <th width="16%">参考视频</th>
+ <td width="28%"></td>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
+ <td width="28%"></td>
</tr>
<tr>
- <th>复刻视频</th>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
- <td><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
+ <th width="16%">复刻视频</th>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
+ <td width="28%"><video src="https://github.com/user-attachments/assets/45ae9d58-6da4-495f-914b-aa6d2b60f1f9" controls muted></video></td>
</tr>
<tr>
<td colspan="4">本地部署的 MiniMax H3,3 次 GPT Image 2 生成;排行榜、TikTok 风格字幕和视觉特效由无头 Chromium 渲染。<b>总成本:$0.15。</b></td>
@@ -127,6 +127,17 @@ npx skills add hypit-ai/hypit -g
Agent 会检查环境,只索要这条视频需要的凭据,先给出预览,再执行构建。
+## 贡献指南
+
+欢迎提交 Pull Request,文档、示例和翻译与代码同样重要。可以认领一个已有的 issue,也可以为你想做的事新开一个,我们会协助你把它合并进来。环境准备、CI 会跑的检查和 Pull Request 流程见 [CONTRIBUTING.zh-CN.md](./CONTRIBUTING.zh-CN.md)。
+
+[开发指南](https://docs.hypit.ai/zh/guide/develop)说明了前置条件、日常命令和仓库结构。[添加 Author 包](https://docs.hypit.ai/zh/guide/author-packages)和[添加 Provider](https://docs.hypit.ai/zh/guide/providers)覆盖了最常见的两类贡献,[代码规范](https://docs.hypit.ai/zh/guide/conventions)说明 Pull Request 需要遵循的要求。
+
+| 缺陷报告 | 功能请求 | 问题咨询 |
+| --- | --- | --- |
+| [提交 issue](https://github.com/hypit-ai/hypit/issues/new?labels=bug) | [提交 issue](https://github.com/hypit-ai/hypit/issues/new?labels=enhancement) | [Discord](https://discord.gg/85hnyQnxpn) 或 [Telegram](https://t.me/hypit) |
+| 行为与文档描述不一致 | 新能力或改进的想法 | 关于创作、包和 Provider 的提问 |
+
## 许可证
Hypit 采用 [Hypit 开源许可证](./LICENSE)。你创作的视频和其他产出归你所有;第三方模型与服务可能另有条款。