From b7b95f9f675408e7ca1f8a75e3935a52a0d1e3dd Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Mon, 3 Jul 2023 16:24:13 -0400 Subject: [PATCH 1/7] created template --- src/surface/surface_main/examples/TEMPLATE.md | 90 +++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 src/surface/surface_main/examples/TEMPLATE.md diff --git a/src/surface/surface_main/examples/TEMPLATE.md b/src/surface/surface_main/examples/TEMPLATE.md new file mode 100644 index 00000000..3deabc5d --- /dev/null +++ b/src/surface/surface_main/examples/TEMPLATE.md @@ -0,0 +1,90 @@ + + +# Package Name + +## Overview + +This is a template: replace, remove, and add where required. Describe here what this package does and what it's meant for in a few sentences. + +* **Author: John Doe** + +* **Maintainer: John Doe, ** + +## Installation + +Describe any dependencies not install by rosdep + +## Usage + +Describe the quickest way to run this software, for example: + +Run the main node with + +```bash +roslaunch ros_package_template ros_package_template.launch +``` + +## Config files + +Config file folder/set 1 + +* **config_file_1.yaml** Shortly explain the content of this config file + +Config file folder/set 2 + +* **...** + +## Launch files + +* **launch_file_1.launch:** shortly explain what is launched (e.g standard simulation, simulation with gdb,...) + + Argument set 1 + + * **`argument_1`** Short description (e.g. as commented in launch file). Default: `default_value`. + + Argument set 2 + + * **`...`** + +* **...** + +## Nodes + +### ros_package_template + +Reads temperature measurements and computed the average. + +#### Subscribed Topics + +* **`/temperature`** ([sensor_msgs/Temperature]) + + The temperature measurements from which the average is computed. + +#### Published Topics + +... + +#### Services + +* **`get_average`** ([std_srvs/Trigger]) + + Returns information about the current average. + +#### Parameters + +* **`subscriber_topic`** (string, default: "/temperature") + + The name of the input topic. + +* **`cache_size`** (int, default: 200, min: 0, max: 1000) + + The size of the cache. + +### NODE_B_NAME + +... + +[std_srvs/Trigger]: http://docs.ros.org/api/std_srvs/html/srv/Trigger.html +[sensor_msgs/Temperature]: http://docs.ros.org/api/sensor_msgs/html/msg/Temperature.html From f289c1554f343c55c4499f3ca13a1272bf0dbd76 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom <36806982+InvincibleRMC@users.noreply.github.com> Date: Tue, 4 Jul 2023 05:13:00 -0400 Subject: [PATCH 2/7] Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 27 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..23fcbccc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..e0c0168b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE]" +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From 3d2cdc767d2cd98571e84db317619e7f41dce55e Mon Sep 17 00:00:00 2001 From: Michael Carlstrom <36806982+InvincibleRMC@users.noreply.github.com> Date: Tue, 4 Jul 2023 05:31:04 -0400 Subject: [PATCH 3/7] Create PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 54 ++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..5c06ec42 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,54 @@ + + +## What type of PR is this? (check all applicable) + +- [ ] Refactor +- [ ] Feature +- [ ] Bug Fix +- [ ] Optimization +- [ ] Documentation Update + +## Description + +## Related Tickets & Documents + + + +- Related Issue # +- Closes # + +## Added/updated tests? + +- [ ] Yes +- [ ] No, and this is why: _please replace this line with details on why tests + have not been included_ +- [ ] I need help with writing tests + +## [optional] Are there any post deployment tasks we need to perform? + From 9bf76daa3fafa4d8d5de3714a0023839620d30c5 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 5 Jul 2023 11:35:28 -0400 Subject: [PATCH 4/7] ben pr --- .github/ISSUE_TEMPLATE/bug-report.md | 4 +--- .github/PULL_REQUEST_TEMPLATE.md | 11 +---------- src/surface/surface_main/examples/TEMPLATE.md | 16 ++-------------- 3 files changed, 4 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 23fcbccc..40626eb5 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -12,6 +12,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' @@ -20,8 +21,5 @@ Steps to reproduce the behavior: **Expected behavior** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. - **Additional context** Add any other context about the problem here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5c06ec42..aaab2576 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,6 +18,7 @@ with a `/ci` reply to the PR, it will be allowed to run subsequent builds without manual approval. --> +# Pull Request ## What type of PR is this? (check all applicable) @@ -42,13 +43,3 @@ automatically close the issue. - Related Issue # - Closes # - -## Added/updated tests? - -- [ ] Yes -- [ ] No, and this is why: _please replace this line with details on why tests - have not been included_ -- [ ] I need help with writing tests - -## [optional] Are there any post deployment tasks we need to perform? - diff --git a/src/surface/surface_main/examples/TEMPLATE.md b/src/surface/surface_main/examples/TEMPLATE.md index 3deabc5d..f2cb639e 100644 --- a/src/surface/surface_main/examples/TEMPLATE.md +++ b/src/surface/surface_main/examples/TEMPLATE.md @@ -10,8 +10,6 @@ This is a template: replace, remove, and add where required. Describe here what * **Author: John Doe** -* **Maintainer: John Doe, ** - ## Installation Describe any dependencies not install by rosdep @@ -23,7 +21,7 @@ Describe the quickest way to run this software, for example: Run the main node with ```bash -roslaunch ros_package_template ros_package_template.launch +ros2 launch ros_package_template ros_package_template.launch ``` ## Config files @@ -32,24 +30,14 @@ Config file folder/set 1 * **config_file_1.yaml** Shortly explain the content of this config file -Config file folder/set 2 - -* **...** - ## Launch files -* **launch_file_1.launch:** shortly explain what is launched (e.g standard simulation, simulation with gdb,...) +* **launch_file_1_launch.py:** shortly explain what is launched (e.g standard simulation, simulation with gdb,...) Argument set 1 * **`argument_1`** Short description (e.g. as commented in launch file). Default: `default_value`. - Argument set 2 - - * **`...`** - -* **...** - ## Nodes ### ros_package_template From ab3315b1e568095f42ba15387677703c53fd529b Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 5 Jul 2023 11:40:16 -0400 Subject: [PATCH 5/7] ben pr 2 --- .github/PULL_REQUEST_TEMPLATE.md | 20 ------------------- src/surface/surface_main/examples/TEMPLATE.md | 2 -- 2 files changed, 22 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aaab2576..d18c099e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,23 +1,3 @@ - # Pull Request ## What type of PR is this? (check all applicable) diff --git a/src/surface/surface_main/examples/TEMPLATE.md b/src/surface/surface_main/examples/TEMPLATE.md index f2cb639e..3c56a9dd 100644 --- a/src/surface/surface_main/examples/TEMPLATE.md +++ b/src/surface/surface_main/examples/TEMPLATE.md @@ -34,8 +34,6 @@ Config file folder/set 1 * **launch_file_1_launch.py:** shortly explain what is launched (e.g standard simulation, simulation with gdb,...) - Argument set 1 - * **`argument_1`** Short description (e.g. as commented in launch file). Default: `default_value`. ## Nodes From c0b6a63f7e700f369653de847459a80372e78a47 Mon Sep 17 00:00:00 2001 From: Benjamin Poulin <90342856+benjaminwp18@users.noreply.github.com> Date: Wed, 5 Jul 2023 11:52:50 -0400 Subject: [PATCH 6/7] ROS2 launch file name --- src/surface/surface_main/examples/TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/surface/surface_main/examples/TEMPLATE.md b/src/surface/surface_main/examples/TEMPLATE.md index 3c56a9dd..309edee2 100644 --- a/src/surface/surface_main/examples/TEMPLATE.md +++ b/src/surface/surface_main/examples/TEMPLATE.md @@ -21,7 +21,7 @@ Describe the quickest way to run this software, for example: Run the main node with ```bash -ros2 launch ros_package_template ros_package_template.launch +ros2 launch ros_package_template ros_package_template_launch.py ``` ## Config files From 06eb00a1c6401f71d6c2c0528475280024554142 Mon Sep 17 00:00:00 2001 From: Michael Carlstrom Date: Wed, 5 Jul 2023 12:42:51 -0400 Subject: [PATCH 7/7] moved template --- {src/surface/surface_main/examples => doc}/TEMPLATE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {src/surface/surface_main/examples => doc}/TEMPLATE.md (100%) diff --git a/src/surface/surface_main/examples/TEMPLATE.md b/doc/TEMPLATE.md similarity index 100% rename from src/surface/surface_main/examples/TEMPLATE.md rename to doc/TEMPLATE.md