From 9843033e585883a5a7fcd84378da15d52d8fdf84 Mon Sep 17 00:00:00 2001 From: Audrow Nash Date: Thu, 22 Feb 2024 21:33:15 +0000 Subject: [PATCH 1/2] Update design docs instructions Signed-off-by: GitHub --- .../Contributing/Developer-Guide.rst | 26 ++++++++----------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/source/The-ROS2-Project/Contributing/Developer-Guide.rst b/source/The-ROS2-Project/Contributing/Developer-Guide.rst index abf89eb487..2a72164095 100644 --- a/source/The-ROS2-Project/Contributing/Developer-Guide.rst +++ b/source/The-ROS2-Project/Contributing/Developer-Guide.rst @@ -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) `__, 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. -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. - * 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 `__ 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#``) in the pull request or the commit message. - Detailed instructions are on the `ROS 2 Contribute `__ 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. -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 ~~~~~~~~~~~~~~~~~~~~~~ @@ -640,7 +636,7 @@ maintainers of all impacted packages (as defined by ``package.xml`` maintainer f * Once consensus is reached: - * Ensure the `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 From 9927f153f9f5dc2579a27ff0fb542b4a80ef657a Mon Sep 17 00:00:00 2001 From: Audrow Nash Date: Thu, 22 Feb 2024 21:57:23 +0000 Subject: [PATCH 2/2] Fix doc Signed-off-by: GitHub --- source/The-ROS2-Project/Contributing/Developer-Guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/The-ROS2-Project/Contributing/Developer-Guide.rst b/source/The-ROS2-Project/Contributing/Developer-Guide.rst index 2a72164095..a1f8579500 100644 --- a/source/The-ROS2-Project/Contributing/Developer-Guide.rst +++ b/source/The-ROS2-Project/Contributing/Developer-Guide.rst @@ -589,7 +589,7 @@ This is different than `ROS Enhancement Proposals (or REPs)