Skip to content

Commit

Permalink
Update new_release_team.md
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Smith-JackSmith authored Nov 28, 2024
1 parent d1ca201 commit 534267c
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/new_release_team.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<YOUR_REPOSITORY_NAME>` with the name of your repository.
- Replace `<YOUR_REPOSITORY_SOURCE_URL>` 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 `<LINK_TO_LINE_NUMBER_OF_SOURCE_FIELD>`**:
- 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)






0 comments on commit 534267c

Please sign in to comment.