From 534267caced137d14efc9e80d08d36a954ca8ad7 Mon Sep 17 00:00:00 2001 From: Jack Smith Date: Thu, 28 Nov 2024 13:09:54 +0100 Subject: [PATCH] Update new_release_team.md Chevrons (< >) for Placeholders, permalink instructions, and example: Chevrons are a widely understood convention for placeholders, improving readability and making it easier to spot text that needs replacement. Detailed instructions for generating a permalink to a line number in distribution.yml file, which evolves over time. Example facilitates the correct format. --- .github/ISSUE_TEMPLATE/new_release_team.md | 30 ++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/new_release_team.md b/.github/ISSUE_TEMPLATE/new_release_team.md index d861101..f5071a8 100644 --- a/.github/ISSUE_TEMPLATE/new_release_team.md +++ b/.github/ISSUE_TEMPLATE/new_release_team.md @@ -25,3 +25,33 @@ title: 'Add release team' * Team members * [@FIRST_MAINTAINER_GITHUB_USERNAME](LINK TO SOURCE PACKAGE.XML MAINTAINER/AUTHOR TAG) * ... + +### Example of Proper Formatting +``` +* [ament_cmake](https://github.com/ament/ament_cmake.git) + * [ros/rolling source entry](https://github.com/ros/rosdistro/blob/0d66d7f62975229ed0b1031137f8324ee568cc3e/rolling/distribution.yaml#L149) +``` + +### Instructions for Filling This Template +1. **Repository Name and Source URL**: + - Replace `` with the name of your repository. + - Replace `` with the link to your source repository. + +2. **Adding a Permalink to the Source Field**: + - Navigate to the appropriate `distribution.yml` file for your ROS distribution (e.g., `humble/distribution.yaml`). + - Find the "source" entry corresponding to your repository. + - Click the **line number** to the left of the entry. + - A menu will appear. Select **"Copy Permalink"** to generate a stable link to that line. + +3. **Replace ``**: + - Paste the copied permalink into the placeholder. + +### Final Template Example +* [franka_description](https://github.com/frankaemika/franka_description.git) + * [ros/humble source entry](https://github.com/ros/rosdistro/blob/0d66d7f62975229ed0b1031137f8324ee568cc3e/humble/distribution.yaml#L230) + + + + + +