Help us learn about your current experience with the documentation. Take the survey.

使用 Gitpod 贡献代码

现在到了有趣的部分。让我们来编辑一些代码。

在这个例子中,我发现了一些想要更改的 UI 文本。 在 GitLab 的右上角,我点击了我的头像,然后选择了 偏好设置。 我想将 Syntax highlighting theme 更改为 Code syntax highlighting theme

本教程旨在作为参与 GitLab 项目的通用介绍,而不是一个应提交审核的更改示例。

  1. 为你的更改创建一个新分支:

    在状态栏中选择 master,然后从 Select a branch or tag to checkout(检出分支或标签)框中,选择 Create new branch(创建新分支),并为新分支输入一个名称。

    如果你的代码更改是为了解决某个 issue,请以 issue 编号作为分支名的前缀

    本文档中的示例使用了一个名为 ui-updates 的新分支。

  2. 在代码库中搜索字符串 Syntax highlighting theme

    • 在 VS Code 中,从侧边栏选择搜索图标
  3. 选择 app/views/profiles/preferences/show.html.haml 文件。

  4. 将该字符串更新为 Code syntax highlighting theme

  5. 保存你的更改。

  6. 使用 IDE 的 Terminal(终端)选项卡来提交更改:

    git commit -m "Update UI text
    
    Standardizing the text on this page so
    that each area uses consistent language."

    请遵循 GitLab 提交信息指南

  7. 将更改推送到新分支:

    git push --set-upstream origin ui-updates
  8. 你可以使用此代码更改创建合并请求,或者继续更新翻译文件。

更新翻译文件

英文 UI 字符串会被本地化成多种语言。 这些字符串保存在一个 .pot 文件中,每次更新 UI 文本后都必须重新生成该文件。

要自动重新生成本地化文件:

  1. 确保你位于 gitlab-development-kit/gitlab 目录下。

  2. 运行以下命令:

    tooling/bin/gettext_extractor locale/gitlab.pot

    .pot 文件将在 /locale 目录中生成。

    现在,在 gitlab-development-kit/gitlab 目录中,如果你输入 git status,你应该会看到这两个文件被列出:

            modified:   app/views/profiles/preferences/show.html.haml
            modified:   locale/gitlab.pot
  3. 提交并推送更改。

  4. 创建合并请求或继续更新文档。

有关本地化的更多信息,请参阅国际化

更新文档

GitLab 的文档发布在 https://docs.gitlab.com。 当你添加或更新一个功能时,你也必须更新相应的文档。

  1. 要查找某个功能的文档,最简单的方法是搜索文档站点。 在这个例子中,该设置在此文档页面中有描述:

    https://docs.gitlab.com/ee/user/profile/preferences.html
  2. URL 显示了文件在 /doc 目录中的位置。 在这个例子中,位置是:

    doc/user/profile/preferences.md
  3. 在你本地的 gitlab 代码库中导航到该位置,并更新 .md 文件和任何相关的图片。

    现在当你运行 git status 时,你应该会看到类似以下内容:

            modified:   app/views/profiles/preferences/show.html.haml
            modified:   doc/user/profile/img/profile-preferences-syntax-themes.png
            modified:   doc/user/profile/preferences.md
            modified:   locale/gitlab.pot
  4. 提交并推送更改。

  5. 创建合并请求或继续更新文档。