[larry-robotics#3] Address review findings

Signed-off-by: Christian Eltzschig <[email protected]>
elfenpiff · Oct 31, 2023 · 432647e · 432647e
1 parent 8fd48c1
commit 432647e
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -10,13 +10,18 @@ assignees: ''
 ## Required information
 
 **Operating system:**
-Output of: `uname -a`
+ * OS name, version
+ * Additionally, on Linux, Mac Os, Unix, output of: `uname -a`
+ * Additionally, on Windows, output of: `ver`
 
 **Rust version:**
 Output of: `rustc --version`
 
+**Cargo version:**
+Output of: `cargo --version`
+
 **elkodon version:**
-E.g. `v1.2.3` or `master` branch
+E.g. `v1.2.3` or `main` branch
 
 **Observed result or behaviour:**
 A minimalistic running code example that reproduces the bug or

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,7 +9,7 @@
 1. [ ] Every source code file has the SPDX header `SPDX-License-Identifier: $(LICENSE_CODE)`
 1. [ ] Branch follows the naming format (`elk-123-introduce-posix-ipc-example`)
 1. [ ] Commits messages are according to this [guideline][commit-guidelines]
-    - [ ] Commit messages have the issue ID (`[#123] add posix ipc example`)
+    - [ ] Commit messages have the issue ID (`[#123] Add posix ipc example`)
     - [ ] Commit author matches [Eclipse Contributor Agreement][eca] (and ECA is signed)
 1. [ ] Tests follow the [best practice for testing][testing]
 1. [ ] Changelog updated [in the unreleased section][changelog] including API breaking changes
@@ -34,4 +34,4 @@
 
 ## References
 
-- Closes **TBD**
+<!-- Use 'Closes #123' or 'Relates to #123' -->
diff --git a/README.md b/README.md
@@ -27,8 +27,14 @@
 <table>
   <tbody>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/elboberido"><img src="https://avatars.githubusercontent.com/u/56729607" width="100px;" alt="Mathias Kraus"/><br /><sub><b>Mathias Kraus</b></sub></a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/elfenpiff"><img src="https://avatars.githubusercontent.com/u/56729169" width="100px;" alt="Christian Eltzschig"/><br /><sub><b>Christian Eltzschig</b></sub></a></td>
+      <td align="center" valign="top" width="14.28%">
+          <a href="https://github.com/elboberido">
+          <img src="https://avatars.githubusercontent.com/u/56729607" width="100px;" alt="Mathias Kraus"/><br />
+          <sub><b>Mathias »elBoberido« Kraus</b></sub></a></td>
+      <td align="center" valign="top" width="14.28%">
+          <a href="https://github.com/elfenpiff">
+          <img src="https://avatars.githubusercontent.com/u/56729169" width="100px;" alt="Christian Eltzschig"/><br />
+          <sub><b>Christian »elfenpiff« Eltzschig</b></sub></a></td>
     </tr>
   </tbody>
 </table>

diff --git a/doc/release-notes/elkodon-unreleased.md b/doc/release-notes/elkodon-unreleased.md
@@ -30,8 +30,8 @@
 
     ```rust
     // old
-    let fuu = Hello().IsItMeYouAreLookingFor()
+    let fuu = hello().is_it_me_you_re_looking_for()
 
     // new
-    let fuu = Hello().MyNameIsBlobb()
+    let fuu = hypnotoad().all_glory_to_the_hypnotoad()
     ```