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

通过 GDK 贡献代码

现在,让我们进入有趣的部分:编辑代码。

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

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

使用你本地的 IDE 来修改 GDK 目录下的代码。

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

    git checkout -b ui-updates
  2. gitlab-development-kit/gitlab 目录中搜索字符串 Syntax highlighting theme。 结果显示了一个 .haml 文件和几个 .po 文件。

  3. 打开 app/views/profiles/preferences/show.html.haml 文件。

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

  5. 保存文件。

  6. 你可以检查一下是否成功:

    gitlab-development-kit/gitlab 目录中,输入 git status 来显示你修改的文件:

            modified:   app/views/profiles/preferences/show.html.haml
  7. 刷新你正在查看 GDK 的网页浏览器。 更改应该会显示出来。请截取一张屏幕截图。

  8. 提交更改:

    git commit -a -m "更新 UI 文本
    
    标准化此页面上的文本,以便每个区域使用一致的语言。"

    请遵循 GitLab 提交信息指南

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

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

更新翻译文件

英文 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. 创建合并请求 或继续更新文档。