Skip to content
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

Jump to bottom

Update design docs instructions #4183

Open
wants to merge 2 commits into
base: rolling
Choose a base branch
from
Open

Update design docs instructions #4183

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9843033
Update design docs instructions
audrow Feb 22, 2024
9927f15
Fix doc
audrow Feb 22, 2024
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
26 changes: 11 additions & 15 deletions source/The-ROS2-Project/Contributing/Developer-Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,23 +584,19 @@ If a design review is happening in the later stages, the changes will be part of
Writing the design document
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Design docs must never include confidential information.
Whether or not a design document is required for your change depends on how big the task is.
Design docs are a way to document repository or package specific design decisions.
This is different than `ROS Enhancement Proposals (or REPs) <https://ros.org/reps/rep-0000.html>`__, which are for larger decisions that often effect the ROS community.
If you are unsure if you should do a design document or a REP, you can ask the ROS 2 team.
A good place to ask is in the weekly ROS 2 meeting, or in a Github issue in a relevant ROS 2 repository.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
A good place to ask is in the weekly ROS 2 meeting, or in a Github issue in a relevant ROS 2 repository.
A good place to ask is to open a GitHub issue in a relevant ROS 2 repository.


1. You are making a small change or fixing a bug:
Design docs should be placed in a ``doc`` directory in the relevant repository or package.
And submitted as a pull request that references any related Github issues.
Make sure to mention any additional context in the pull request such as if the design doc is intended for a specific ROS version.
Feedback for the design doc wil be made directly on the pull request.
Comment on lines +592 to +595
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Design docs should be placed in a ``doc`` directory in the relevant repository or package.
And submitted as a pull request that references any related Github issues.
Make sure to mention any additional context in the pull request such as if the design doc is intended for a specific ROS version.
Feedback for the design doc wil be made directly on the pull request.
Design docs should be placed in a ``doc`` directory in the relevant repository or package.
Make sure to mention any additional context in the pull request such as if the design doc is intended for a specific ROS version.
Feedback for the design doc will be made directly on the pull request.


* A design document is not required, but an issue should be opened in the appropriate repository to track the work and avoid duplication of efforts.

2. You are implementing a new feature or would like to contribute to OSRF-owned infrastructure (like Jenkins CI):

* Design doc is required and should be contributed to `ros2/design <https://github.com/ros2/design/>`__ to be made accessible on https://design.ros2.org/.
* You should fork the repository and submit a pull request detailing the design.

Mention the related ros2 issue (for example, ``Design doc for task ros2/ros2#<issue id>``) in the pull request or the commit message.
Detailed instructions are on the `ROS 2 Contribute <https://design.ros2.org/contribute.html>`__ page.
Design comments will be made directly on the pull request.
.. note::
Design docs should never include confidential information and they are not required for bug fixes.
Comment on lines +597 to +598
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. note::
Design docs should never include confidential information and they are not required for bug fixes.
.. note::
Design docs should never include confidential information and they are not required for bug fixes.


If the task is planned to be released with a specific version of ROS, this information should be included in the pull request.

Design document review
~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -640,7 +636,7 @@ maintainers of all impacted packages (as defined by ``package.xml`` maintainer f

* Once consensus is reached:

* Ensure the `ros2/design <https://github.com/ros2/design/>`__ pull request has been merged, if applicable
* Ensure the design pull request has been merged, if applicable
* Update and close the GitHub issue associated with this design task

Implementation
Expand Down
Loading