Pull request checks

了解如何让您的拉取请求成功通过所有检查

当您在 opentelemetry.io 存储库 中发起 拉取请求 (PR) 时，会执行一系列检查。PR 检查会验证：

简易 CLA

如果您尚未 签署 CLA，此检查将失败。

Netlify 部署

如果 Netlify 构建失败，请选择“详细信息”以获取更多信息。

GitHub PR 检查

为了确保贡献符合我们的 风格指南，我们实施了一系列检查，以验证风格指南规则，并在发现任何问题时失败。

以下列表描述了当前检查以及您可以如何修复相关错误：

文本 linter

此检查验证 OpenTelemetry 特定的术语和单词在整个站点中是否一致使用。

如果发现任何问题，都会在 PR 的“已更改文件”视图中向您的文件添加注释。修复这些问题即可将检查变为绿色。或者，您可以在本地运行 npm run check:text -- --fix 来自动修复大多数问题。再次运行 npm run check:text 并手动修复剩余问题。

Markdown linter

此检查验证 Markdown 文件的标准和一致性是否得到强制执行。

如果发现任何问题，请运行 npm run fix:markdown 来自动修复大多数问题。对于任何剩余问题，请运行 npm run check:markdown 并手动应用建议的更改。

拼写检查

此检查验证 所有单词是否拼写正确。

如果此检查失败，请在本地运行 npm run check:spelling 以查看拼写错误的单词。如果某个单词拼写正确，您可能需要将其添加到文件中 front matter 的 cSpell:ignore 部分。

CSPELL 检查

此检查将验证您 cSpell 忽略列表中的所有单词是否已规范化。

如果此检查失败，请在本地运行 npm run fix:dict，然后提交更改。

文件格式

此检查验证所有文件是否符合 Prettier 格式规则。

如果此检查失败，请在本地运行 npm run fix:format，然后提交更改。

文件名检查

此检查验证所有 文件名是否为 kebab-case。

如果此检查失败，请在本地运行 npm run fix:filenames，然后提交更改。

这两项检查会构建网站并验证所有链接是否有效。

要在本地构建和检查链接，请运行 npm run check:links。此命令还会更新引用缓存。将 refcache 中的任何更改提交。

修复 404

您需要修复链接检查器报告的无效 URL（HTTP 状态码404）。

链接检查器有时会从阻止检查器的服务器那里收到除 200（成功）以外的 HTTP 状态码。这些服务器通常会返回 400 范围内的 HTTP 状态码，而非 404，例如 401、403 或 406，这些是最常见的。一些服务器，如 LinkedIn，会返回 999。

如果您已手动验证了链接检查器未获得成功状态的外部链接，可以在 URL 后添加以下查询参数，以使其被链接检查器忽略：?no-link-check。例如，https:/some-example.org?no-link-check 将被链接检查器忽略。

构建日志中的警告？

如果此检查失败，请查看 构建与检查链接 日志，在 npm run log:check:links 步骤下，查找任何其他潜在问题。如果您不确定如何恢复，请向维护者寻求帮助。


最后修改于 2025 年 11 月 1 日：Contrib note fix and CI/CD pre-commit hook prep (#8314) (7cfe6198)