贡献 Wiki

您已经决定要编辑 Wiki 了，太棒了！本页将向您展示如何开始。请按照最适合您的说明进行操作。

克隆 Wiki

使用 repo

如果您已经检出了 LineageOS 源代码树，则此步骤已完成。Wiki 的 git 仓库位于 $LINEAGE_SRC/lineage/wiki 下。

使用 git

如果您的设备上没有 LineageOS 源代码树，则可以从 GitHub 克隆 Wiki 到您喜欢的任何目录。在本例中，我们将使用 ~/lineage_wiki。

安装 Git

在 Windows 上

安装 Git for Windows。

在 macOS 上

使用 Git 安装程序 安装 Git。

在 Linux 上

您可以运行以下命令安装 Git

sudo apt install git

有关不同发行版的更具体说明，请访问 此处。

配置 Git

运行

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

git clone https://github.com/LineageOS/lineage_wiki ~/lineage_wiki
cd ~/lineage_wiki
curl -Lo .git/hooks/commit-msg https://review.lineageos.org/tools/hooks/commit-msg
chmod +x .git/hooks/commit-msg

进行和预览更改

您现在可以使用您喜欢的文本编辑器在此文件夹中进行更改。如果您需要将文件夹重置为已知良好状态，擦除您的更改，只需运行

git reset --hard HEAD

使用 GitHub 预览

这可能是最简单的方法，但需要您 fork 了 Wiki 仓库，并从该仓库克隆。

提交并预览您的更改

运行

git add .
git commit

将弹出一个编辑器。在第一行，输入对您更改的简短描述（少于 80 个字符），然后放一个空行，如果您愿意，还可以对您的更改进行更详细的描述。例如

Add the contributing page

The contributing page will show people how they can edit our wiki, which
is important, since it wouldn't be much of a wiki without editors.

保存文件并退出编辑器。现在将您的更改上传到 GitHub

git push origin

预览您的更改 - 您可以在 http://yourusername.github.io/lineage_wiki 查看您的 Wiki fork。

修复错误

所以，您已经进行了更改，并且可以在 GitHub Pages 上查看 Wiki。但是有些地方出错了！您打错了字 - 或意外删除了某些内容。不要害怕！您可以修复它。

首先，修复您犯的错误。然后，将它们推送到 GitHub

git add .
git commit --amend

您的提交消息应该会出现在编辑器中。您可以编辑它，或者只是退出编辑器。最后，运行

git push --force origin

使用 Docker 本地预览

安装 Docker

添加 Docker 密钥环并安装软件包

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt update
sudo apt install docker-ce

将您的用户帐户添加到 docker 组，以便在不加 sudo 前缀的情况下使用 Docker 命令

sudo gpasswd -a $USER docker
newgrp docker

然后注销您的用户帐户并重新登录或重启，以使组 membership 更改生效。

构建 Docker 镜像

这将构建 Docker 镜像，这应该只需要完成一次

cd $LINEAGE_SRC/lineage/wiki #Or to wherever you cloned the repository
docker build -t lineageos/wiki .

编辑 Wiki

每次您想要编辑 Wiki 时，您都需要启动一个运行 Jekyll 的本地 Web 服务器

cd $LINEAGE_SRC/lineage/wiki
docker run -p 4000:4000 -v $(pwd):/src -it lineageos/wiki

此时，您应该能够查看 本地 Jekyll 服务器。

使用 RVM 和 Jekyll 本地预览

安装 rvm

rvm 是一个很棒的工具，可以将 Ruby 的不同用法彼此隔离。在此设置过程中，您将安装 ruby 和一组 Ruby 模块（gems），这些模块将与机器上（现在和将来）的任何其他 Ruby 用法隔离。

如果您尚未安装 rvm，请继续安装它

gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
curl -sSL https://get.rvm.io | bash -s stable

配置 ruby 以编辑 Wiki

这些步骤将通过 rvm 配置和安装最新版本的 Ruby MRI。所有 gems（模块）都存储在 lineage_wiki 命名空间中，并且环境将被配置为允许远程访问 GitHub。配置完成后，将安装 ruby 并下载所需的 gems

cd $LINEAGE_SRC/lineage/wiki
echo ruby > .ruby-version
echo lineage_wiki > .ruby-gemset
rvm install ruby
gem install bundler rails
bundle install

编辑 Wiki

每次您想要编辑 Wiki 时，您都需要启动一个运行 Jekyll 的本地 Web 服务器

source ~/.rvm/scripts/rvm
cd $LINEAGE_SRC/lineage/wiki
bundle exec jekyll serve --incremental

此时，您应该能够查看 本地 Jekyll 服务器。

上传您的更改

LineageOS 使用 Gerrit 来审查提出的更改。在您开始之前，您需要 创建一个帐户，并 配置一个 SSH 密钥（您将需要使用 ed25519 类型的密钥）。

完成此操作后，您可以将您的提交推送到 Gerrit

git remote add gerrit ssh://<gerritusername>@review.lineageos.org:29418/LineageOS/lineage_wiki
git push gerrit HEAD:refs/for/main

您可以添加 “Wiki Editors” 组作为 reviewers（点击 “reviewers” 右侧的小人图标）。有人会：评论 patch，要求澄清或指出错别字。您可以回复他们，或 修复他们指出的任何问题，然后重新运行

git push gerrit HEAD:refs/for/main

最终，当您的更改看起来完美时，有人会批准它，并将其提交到 Wiki。太棒了！