如何为本网站做贡献

这解释了成功向此站点提交更改所需了解的内容。

学习目标

  • 如何在本地构建此网站。

  • 如何检查断开的链接。

  • 如何检查拼写和格式。

  • 如何在本地运行 CI 以检查代码更改。

要求

  • Ubuntu 20.04

  • ROS 2 Galactic

  • Docker

  • 一个 colcon 工作区，其中包含 moveit2_tutorials repo 的副本（如果您还没有，入门 将引导您完成创建过程）。

步骤

  1. 在本地构建和查看网站

首先，“cd”到 moveit2_tutorials 存储库的根目录（如果您遵循了 Getting Started 教程，则该目录为“~/ws_moveit/src/moveit2_tutorials”）。从该目录运行以下命令：

make html
# Or run the following lines if you want to automatically rebuild the website on new changes
while inotifywait -re modify,move,create,delete .; do
  make html
done

然后，您可以从以下网址在 Web 浏览器中打开站点的本地构建版本：“./build/html/index.html”。例如，要在默认浏览器中打开本地站点，命令如下：

xdg-open ./build/html/index.html

  1. 测试断开的链接

要测试断开的链接，请运行“htmlproofer”脚本。请注意，运行此脚本可能需要您安装一些 Python 依赖项。如果使用“pip”安装这些依赖项，您可能需要创建一个虚拟环境。

python3 -m venv .venv
source .venv/bin/activate

然后您可以使用“pip”安装要求：

pip3 install --upgrade --requirement requirements.txt

您可以使用以下命令运行“htmlproofer”脚本：

./htmlproofer.sh

  1. 运行格式化程序和拼写检查程序

我们使用 pre-commit 来运行格式和拼写检查器。 你可以像这样使用 pip 安装它：

python3 -m pip install --user pre-commit

要在本地运行预提交来修复格式和拼写：

pre-commit run --all

4.本地运行industrial_ci，运行CI

  • 将 industrial_ci 的副本克隆到您的工作区。

  • 构建并获取您的工作区。

  • 从工作区目录运行此命令来测试代码更改，就像在 CI 中一样：

    ros2 run industrial_ci rerun_ci src/moveit2_tutorials \
  DOCKER_IMAGE='moveit/moveit2:rolling-source' \
  UPSTREAM_WORKSPACE='moveit2_tutorials.repos' \
  TARGET_CMAKE_ARGS='-DCMAKE_BUILD_TYPE=Release' \
  CCACHE_DIR="$HOME/.ccache" \
  CLANG_TIDY='true'

进一步阅读