Skip to content

several cosmetic fixes. #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fujitatomoya wants to merge 1 commit into
base: main
Choose a base branch
from
Open

several cosmetic fixes. #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Gemfile.lock
.jekyll-metadata
_site

# Ruby LSP
.ruby-lsp
Comment on lines +11 to +12
Copy link
Author

@fujitatomoya fujitatomoya Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is similar to how you'd ignore other editor/tool-specific directories


# RubyGems
*.gem

Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Robotics Enhancement Proposals Official Source

This repository is the offical source of the Robotics Enhancement Proposals (REP) of the Open Source Robotics Alliance Technical Governance Committee.
This repository is the official source of the Robotics Enhancement Proposals (REP) of the Open Source Robotics Alliance Technical Governance Committee.
Copy link
Author

@fujitatomoya fujitatomoya Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few typo fixes. i can enable codespell workflow, let me know if you need it.


# REP submission process

On October 23rd, 2025 the [Open Source Robotics Alliance (OSRA)](https://osralliance.org/) Technical Governance Comittee (TGC) launched our new REP process.
On October 23rd, 2025 the [Open Source Robotics Alliance (OSRA)](https://osralliance.org/) Technical Governance Committee (TGC) launched our new REP process.
Details on how to submit new REPs can be found in [REP-0001:2025](https://reps.openrobotics.org/rep-0001-2025/).
Additional details can be found in our [announcement on ROS Discourse](https://discourse.openrobotics.org/t/launch-of-the-osras-new-robotics-enhancement-proposal-rep-process/50668).
The REP review process is significantly different from most conventional source code repositoires. **We recommend you read REP-0001:2025 in its entirety before [submitting a pull request.]((https://reps.openrobotics.org/rep-0001-2025/))**.
Expand All @@ -19,7 +19,7 @@ A specification of the REP numbering system can be [found in REP-0001:2025](http

# REP template

A template REP sumbission can be found in [REP-0004:2025 - Sample Markdown REP Template](https://github.com/openrobotics/reps/blob/main/_posts/rep-0004%3A2025.md).
A template REP submission can be found in [REP-0004:2025 - Sample Markdown REP Template](https://github.com/openrobotics/reps/blob/main/_posts/rep-0004%3A2025.md).

# Building locally

Expand Down
12 changes: 7 additions & 5 deletions _posts/rep-0001:2025.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,12 +154,13 @@ This includes not just the formatting but also the content.

The Lead Author should then follow the process below, with the assistance of the PMC Sponsor, to submit their REP.

1. The Lead Author forks the REP Repository, switches to a new branch for their addition, creates a directory named `rep-NNNN`, where `NNNN` is the next available REP number not used by a published or in-PR REP, and within that directory creates a file named `rep-NNNN.md`.
See the “[REP naming and numbering](#rep-naming-and-numbering-system)” section for more information.
1. The Lead Author forks the REP Repository, switches to a new branch for their addition, and creates a file named `rep-NNNN.md` in the `_posts/` directory, where `NNNN` is the next available REP number not used by a published or in-PR REP.
Copy link
Author

@fujitatomoya fujitatomoya Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description around here, it does not match the actual implementation. so i tries to be more specific how to register the rep file and directory.

If the REP requires auxiliary files (such as images), create a directory named `rep-NNNN` under `assets/reps/` and place those files there.
See the "[REP naming and numbering](#rep-naming-and-numbering-system)" section for more information.
2. The Lead Author fills in the known header fields in their new file, as appropriate.
Most importantly, the `REP:` field must be set to the same number as used in the filename, and the `Status:` field must be set to `Draft`.
For full details, see the [REP Header](#rep-header) section, below.
3. The Lead Author updates the `CODEOWNERS` file to list, for the new REP's directory, any co-authors or PMC Sponsors who are REP Editors (in other words, they have write access to the REP Repository).
3. The Lead Author updates the `CODEOWNERS` file to list, for the new REP's file path, any co-authors or PMC Sponsors who are REP Editors (in other words, they have write access to the REP Repository).
This will allow those people to be automatically assigned to any pull requests that change the file.
4. The Lead Author pushes their changes to the fork they created in step 1, and submits a pull request to the REP Repository.
5. The REP Editors review the PR for general errors, confirming that the proposed REP meets the minimum readiness criteria.
Expand Down Expand Up @@ -460,7 +461,8 @@ Within the file, lines must not be wrapped, and each sentence must start on a ne
This is necessary to ensure pull request diffs are sufficiently readable.

The file name of a REP document must be `rep-XXXX.md`, where `XXXX` is the REP Number.
The REP file and any [auxiliary files](#auxiliary-files), such as images, must be placed in a directory named `rep-XXXX`, where `XXXX` is the REP Number.
The REP file must be placed in the `_posts/` directory.
Any [auxiliary files](#auxiliary-files), such as images, must be placed in a directory named `rep-XXXX` under the `assets/reps/` directory, where `XXXX` is the REP Number.

A template REP is available in [REP-0004:2025](https://reps.openrobotics.org/rep-0004-2025/).
It is recommended that this template be used when starting to write a new REP.
Expand Down Expand Up @@ -509,7 +511,7 @@ Additionally, when the superseding REP is marked Finalized, those superseded REP
### Auxiliary Files {#auxiliary-files}

REPs may include additional files, such as diagrams and sample source code files.
Auxiliary files must be placed in the [REP's directory](#file-format-and-location).
Auxiliary files must be placed in a directory named `rep-XXXX` under `assets/reps/`, where `XXXX` is the REP Number (see [File format and location](#file-format-and-location)).
There are no restrictions on filenames for auxiliary files.

## REP Checklist
Expand Down