贡献


文档摘要

贡献 本项目欢迎贡献和建议。大多数贡献需要你同意一份贡献者许可协议(CLA),声明你有权并且确实授予我们使用你的贡献的权利。详情请访问 。 重要:在翻译此仓库中的文本时,请确保不要使用机器翻译。我们将通过社区来验证翻译,因此请仅在你熟练掌握的语言中自愿进行翻译。 当你提交一个拉取请求时,CLA-bot会自动确定你是否需要提供CLA,并相应地装饰PR(例如,标签、评论)。只需按照机器人提供的说明操作即可。你只需要在整个使用我们的CLA的所有仓库中执行一次此操作。 行为准则 本项目采用了 Microsoft 开源行为准则。有关更多信息,请参阅 行为准则常见问题解答,或通过 opencode@microsoft.com 发送任何其他问题或评论。 问题或难题?

贡献

本项目欢迎贡献和建议。大多数贡献需要你同意一份贡献者许可协议(CLA),声明你有权并且确实授予我们使用你的贡献的权利。详情请访问 https://cla.microsoft.com

重要:在翻译此仓库中的文本时,请确保不要使用机器翻译。我们将通过社区来验证翻译,因此请仅在你熟练掌握的语言中自愿进行翻译。

当你提交一个拉取请求时,CLA-bot会自动确定你是否需要提供CLA,并相应地装饰PR(例如,标签、评论)。只需按照机器人提供的说明操作即可。你只需要在整个使用我们的CLA的所有仓库中执行一次此操作。

行为准则

本项目采用了 Microsoft 开源行为准则。有关更多信息,请参阅 行为准则常见问题解答,或通过 opencode@microsoft.com 发送任何其他问题或评论。

问题或难题?

请勿为一般支持问题打开 GitHub 问题,因为 GitHub 列表应仅用于功能请求和错误报告。这样我们可以更轻松地跟踪代码中的实际问题或缺陷,并将一般讨论与实际代码分开。

错误、问题、缺陷和贡献

无论何时向 Generative AI for Beginners 仓库提交任何更改,请遵循以下建议:

  • 在提交修改前,请务必先将仓库 Fork 到自己的账户。
  • 不要在一个拉取请求中合并多个更改。例如,应分别提交任何错误修复和文档更新的 PR。
  • 如果你的拉取请求显示合并冲突,请确保在进行修改之前将本地主分支更新为与主仓库保持一致。
  • 如果你正在提交翻译,请为所有翻译文件创建一个 PR,因为我们不接受内容的部分翻译。
  • 如果你正在提交拼写错误或文档修正,请在适当的情况下将对单个 PR 的修改合并。

编写的一般指导原则

  • 确保所有 URL 都用方括号括起来,后跟括号,不要在它们周围或内部添加额外的空格,例如 []()
  • 确保任何相对链接(即指向存储库中其他文件和文件夹的链接)以 ./ 指向当前工作目录中的文件或文件夹,或以 ../ 指向父工作目录中的文件或文件夹。
  • 确保任何相对链接(即指向存储库中其他文件和文件夹的链接)在其末尾包含跟踪 ID(即 ?&,然后是 wt.mc_id=WT.mc_id=)。
  • 确保来自以下域名的任何 URL(即 github.com、microsoft.com、visualstudio.com、aka.ms 和 azure.com)在其末尾包含跟踪 ID(即 ?&,然后是 wt.mc_id=WT.mc_id=)。
  • 确保链接中没有国家特定的区域设置(即 /en-us//en/)。
  • 确保所有图片都存储在 ./images 文件夹中。
  • 确保图片具有描述性的名称,使用英文字符、数字和破折号命名。

GitHub 工作流

当你提交一个拉取请求时,将触发四个不同的工作流来验证上述规则。只需按照此处列出的说明操作,即可通过工作流检查。

检查损坏的相对路径

此工作流确保文件中的任何相对路径都是有效的。
此存储库部署到 GitHub 页面,因此在键入链接时需要非常小心,以确保不会将任何人引导到错误的位置。

为了确保链接正常工作,只需使用 VS 代码检查即可。

例如,当你在文件中悬停在任何链接上时,按 Ctrl + 单击 可以跟随链接。

VS 代码跟随链接截图

如果你单击了一个链接且它在本地不起作用,则肯定会触发工作流,且在 GitHub 上也不会起作用。

要解决此问题,请使用 VS 代码帮助键入链接。

当键入 ./../ 时,VS 代码会根据你键入的内容提示你选择可用选项。

VS 代码选择相对路径截图

点击所需文件或文件夹以继续路径,这样可以确保路径未损坏。

一旦添加了正确的相对路径,保存并推送更改,工作流将再次触发以验证更改。
如果通过检查,则一切正常。

检查路径是否有跟踪

此工作流确保任何相对路径都有跟踪。
此存储库部署到 GitHub 页面,因此我们需要跟踪不同文件和文件夹之间的移动。

要确保相对路径包含跟踪,请检查路径末尾是否附加了 ?wt.mc_id=
如果相对路径末尾附加了跟踪 ID,则你将通过此检查。

如果没有,可能会收到以下错误。

GitHub 检查路径缺少跟踪注释截图

要解决此问题,请尝试打开工作流突出显示的文件路径,并在相对路径末尾添加跟踪 ID。

一旦添加了跟踪 ID,保存并推送更改,工作流将再次触发以验证更改。
如果通过检查,则一切正常。

检查 URL 是否有跟踪

此工作流确保任何网络 URL 都有跟踪。
此存储库可供所有人使用,因此你需要确保跟踪访问以了解流量来源。

要确保 URL 包含跟踪,请检查 URL 末尾是否附加了 ?wt.mc_id=
如果 URL 末尾附加了跟踪 ID,则你将通过此检查。

如果没有,可能会收到以下错误。

GitHub 检查 URL 缺少跟踪注释截图

要解决此问题,请尝试打开工作流突出显示的文件路径,并在 URL 末尾添加跟踪 ID。

一旦添加了跟踪 ID,保存并推送更改,工作流将再次触发以验证更改。
如果通过检查,则一切正常。

检查 URL 是否没有区域设置

此工作流确保任何网络 URL 都没有国家特定的区域设置。
此存储库可供世界各地的人们使用,因此你需要确保不在 URL 中包含你的国家区域设置。

要确保 URL 不包含国家区域设置,请检查 URL 中是否包含以下文本 /en-us//en/ 或任何其他语言区域。
如果 URL 中未包含这些文本,则你将通过此检查。

如果没有,可能会收到以下错误。

GitHub 检查国家区域设置注释截图

要解决此问题,请尝试打开工作流突出显示的文件路径,并从 URL 中删除国家区域设置。

一旦删除了国家区域设置,保存并推送更改,工作流将再次触发以验证更改。
如果通过检查,则一切正常。

恭喜!我们会尽快给你反馈关于你的贡献。

声明:
本文件灏天文库团队进行了翻译。尽管我们力求准确,但请注意,翻译可能包含错误或不准确之处。原文档以其原始语言为准。我们不对因使用此翻译而产生的任何误解或误译负责。


发布者: 作者: 转发
评论区 (0)
U