Update design docs instructions #4183
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: GitHub <[email protected]>
Signed-off-by: GitHub <[email protected]>
clalancette
requested changes
Feb 27, 2024
| 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. |
There was a problem hiding this comment.
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. |
Comment on lines
+592
to
+595
| 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. |
There was a problem hiding this comment.
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. |
Comment on lines
+597
to
+598
| .. note:: | ||
| Design docs should never include confidential information and they are not required for bug fixes. |
There was a problem hiding this comment.
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. |
fujitatomoya
approved these changes
Feb 27, 2024
|
@audrow Friendly ping here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I tried to make the relevant changes to suggest using a
docdirectory and to remove information about our old design docs process.