跳转到主要内容
Livepeer 是一个开源项目,社区贡献对其成长至关重要。您不需要编写代码就能产生有意义的影响——文档改进、治理参与、社区支持和错误报告都是有价值的贡献。

贡献者聚光灯

Get highlighted for your contributions to Livepeer!


贡献方式


贡献代码

开始之前

  • 检查现有问题和讨论 — 在打开新问题或开始工作之前,请在 GitHub 上搜索。快速问一句“有人在做这个吗?”可以节省大家的时间。
  • 为大型变更集打开讨论 — 对于重要的新功能,请先打开 GitHub 讨论或问题。这可以避免在可能不被接受的 PR 上投入精力。
  • 阅读仓库的 CONTRIBUTING.md — 每个仓库都有自己的贡献指南,涵盖设置、测试和 PR 规范。

关键仓库

一般拉取请求原则

这些原则适用于所有 Livepeer 仓库:
  • 保持 PR 专注 — 每个拉取请求一个逻辑变更。较小、范围明确的 PR 更容易审查和合并。
  • 编写可读的提交信息 — 使用 Conventional Commits 格式,按仓库要求使用诸如 fix:feat:docs: 等前缀。
  • 添加测试 — 在添加功能或修复错误时,包括覆盖新行为或更新行为的测试用例。
  • 更新变更日志 — 对于 go-livepeer,在每个 PR 中更新 CHANGELOG_PENDING.md;其他仓库则遵循各自关于在 PR 中更新变更日志的要求。
  • 及时回应审查反馈 — 不要强制推送到正在积极审查的分支。
  • 变基并合并 — 对于较大的变更集,维护者可能会要求进行本地变基,以清理提交历史记录,然后再合并。

贡献文档

Livepeer 文档是开源的,位于 github.com/livepeer/docsdocs-v2 分支。

快速路径:无需代码的反馈

您不需要使用 Git 来贡献文档:
  • 点赞/点踩 — 在任何文档页面上表示其是否有帮助
  • GitHub 问题打开一个问题 描述问题、缺失或困惑的内容。提供八个问题模板。
  • Discord — 在 #lounge 频道分享反馈或标记文档团队成员

拉取请求工作流程

1

Fork the repository

Navigate to github.com/livepeer/docs and click Fork. This creates your own copy.
2

Clone and configure remotes

git clone https://github.com/YOUR_USERNAME/docs.git
cd docs
git remote add upstream https://github.com/livepeer/docs.git
3

Create a branch from docs-v2

git checkout docs-v2
git pull upstream docs-v2
git checkout -b docs-plan/your-short-description
Always branch from docs-v2. Never commit directly to docs-v2 or main.
4

Make your changes

Edit or create .mdx files in the relevant section. Follow the Style Guide for formatting and component usage.Key rules:
  • Use UK English
  • No inline styles — use Mintlify global components or component primitives from /snippets/components/
  • No hardcoded colours — use CSS custom properties
  • Absolute imports only: /snippets/components/... (not relative paths)
5

Run pre-commit checks

The repository has pre-commit hooks that check structure, style, links, spelling, and MDX validity. Run them before pushing:
./lpd hooks run
Or run the full test suite:
node tests/run-pr-checks.js --base-ref docs-v2
6

Open a pull request

Push your branch and open a PR against docs-v2 on the upstream repository. Use the provided PR template and fill it out completely. PRs are reviewed within 48–72 hours on business days.

审查分配

文档更改由定义在 .github/CODEOWNERS 的部分所有者进行审查。通常:
  • 开发者部分 — 开发者关系团队
  • 网关部分 — 网关团队
  • 协调者部分 — 协调者团队
  • 资源 / 跨领域 — 文档团队

参与治理

代币持有者可以在不编写任何代码的情况下参与 Livepeer 治理。
1

Read active proposals

Visit the Livepeer Forum governance category and Explorer voting page to see what is currently open for input.
2

Comment on proposals

Add your perspective on active threads in the forum before proposals move to an on-chain vote. Well-reasoned feedback is valued from all participants.
3

Vote on-chain

If you hold staked LPT, you can cast votes on active proposals directly from the Explorer.
4

Draft a Livepeer Improvement Proposal (LIP)

If you have a protocol improvement idea, draft it on the Forum under the Governance category and solicit community feedback before moving to a formal LIP.

补助和悬赏

如果您想更实质性地贡献并获得报酬:
Grant applications are reviewed bi-weekly by the Livepeer Grants committee. To discuss a potential grant application before submitting, ping the grants team in the #governance Discord channel.

社区贡献原则

这些适用于所有 Livepeer 存储库和贡献类型:
  • 在构建之前阅读 — 在开始重大工作之前检查现有问题和讨论
  • 保持 PR 关注 — 每个拉取请求一个逻辑更改
  • 编写可读的提交信息 — 使用常规提交格式
  • 在审查中保持建设性 — 如果贡献不合适,请解释原因并提供改进建议
  • 链接到相关文档 — 在关闭问题或拒绝 PR 时,尽可能链接到现有资源

Not sure where to start? Search for issues labelled good first issue or help wanted across the Livepeer GitHub organisation. These are specifically tagged as appropriate entry points for new contributors.
Last modified on March 3, 2026