Merge pull request #52 from heliosproj/develop

Merge for 0.4.1 release

Author: MannyPeterson

.github/ISSUE_TEMPLATE/bug-report.md

@@ -6,24 +6,31 @@ labels: bug
 assignees: MannyPeterson
 ---
 
-**PLEASE BE AWARE THAT THIS ISSUE IS FOR REPORTING BUGS ONLY**
+## :dart: **Help us help you by filling out this issue completely. This issue is ONLY for bug reports. If you are seeking support, please submit a support request.**
+### **1. Describe, in detail, the bug you have encountered and how to reproduce it (if providing a source code excerpt, use a markdown code block and please do not provide screenshots of source code):**
 
-###Please describe, in detail, the bug you have encountered **and** how to reproduce it.
 
+### **2. What results, output, behavior are you expecting?**
 
 
-###Please provide a screenshot or text of compiler errors, if any.
+### **3. What version of HeliOS are you using?**
 
 
+### **4. Provide the following details about your development environment and development board/microcontroller:**
 
-###Please provide details about the MCU architecture, platform/tool-chain, development board, etc. you were using when you encountered the bug.
+OS [Windows, macOS, Linux]:
 
+OS Version [Windows 10, Ventura, Ubuntu 22.04]:
 
+IDE [Arduino IDE, PlatformIO, STM32CubeIDE, Keil]:
 
-###What version of HeliOS are you running?
+IDE Version:
 
+Board/MCU Mfg [Arduino, PJRC, ST Micro]:
 
+Board/MCU Model [UNO, Teensy 4.1, NUCLEO-F429ZI]:
 
-###Please attach the application source code file(s) needed to reproduce the bug.
+### **5. Are you experiencing any compiler or linker errors? If so, copy and paste them here (please do not provide screenshots):**
 
 
+### 7. **Attach a copy of your source code file(s) so we may compile them if needed:**

.github/ISSUE_TEMPLATE/everything-else.md

@@ -0,0 +1,10 @@
+---
+name: Other Request
+about: A request that is not a bug report or a request for support
+title: "[OTHER] "
+labels: other
+assignees: MannyPeterson
+---
+
+### **1. How can we help you?**
+

.github/ISSUE_TEMPLATE/other-request.md

@@ -0,0 +1,40 @@
+---
+name: Support Request
+about: Request support for HeliOS
+title: "[SUPPORT] "
+labels: support
+assignees: MannyPeterson
+---
+
+## :dart: **Help us help you by filling out this issue completely.**
+### **1. How can we help you (i.e., what is the issue you are facing)?**
+
+
+### **2. What results, output, behavior are you expecting?**
+
+
+### **3. What version of HeliOS are you using?**
+
+
+### **4. Provide the following details about your development environment and development board/microcontroller:**
+
+OS [Windows, macOS, Linux]:
+
+OS Version [Windows 10, Ventura, Ubuntu 22.04]:
+
+IDE [Arduino IDE, PlatformIO, STM32CubeIDE, Keil]:
+
+IDE Version:
+
+Board/MCU Mfg [Arduino, PJRC, ST Micro]:
+
+Board/MCU Model [UNO, Teensy 4.1, NUCLEO-F429ZI]:
+
+### **5. Are you experiencing any compiler or linker errors? If so, copy and paste them here (please do not provide screenshots):**
+
+
+### **6. If you have questions about a specific block of source code, copy and paste an excerpt of the source code here (use a markdown code block and please do not provide screenshots):**
+
+
+### 7. **Attach a copy of your source code file(s) so we may compile them if needed:**
+

.github/ISSUE_TEMPLATE/support-request.md

@@ -54,9 +54,9 @@ jobs:
           sed -i '/^PROJECT_NAME .*/d' ${{github.workspace}}/temp/HeliOS.conf
           echo 'PROJECT_NAME = HeliOS' >> ${{github.workspace}}/temp/HeliOS.conf
           sed -i '/^PROJECT_NUMBER .*/d' ${{github.workspace}}/temp/HeliOS.conf
-          echo 'PROJECT_NUMBER = Kernel 0.4.0' >> ${{github.workspace}}/temp/HeliOS.conf
+          echo 'PROJECT_NUMBER = Kernel 0.4.1' >> ${{github.workspace}}/temp/HeliOS.conf
           sed -i '/^PROJECT_LOGO .*/d' ${{github.workspace}}/temp/HeliOS.conf
-          echo 'PROJECT_LOGO = ${{github.workspace}}/temp/HeliOS_OG_Logo.png' >> ${{github.workspace}}/temp/HeliOS.conf
+          echo 'PROJECT_LOGO = ${{github.workspace}}/temp/HeliOS_OG_Logo_Light.png' >> ${{github.workspace}}/temp/HeliOS.conf
           sed -i '/^OUTPUT_DIRECTORY .*/d' ${{github.workspace}}/temp/HeliOS.conf
           echo 'OUTPUT_DIRECTORY = ${{github.workspace}}/temp' >> ${{github.workspace}}/temp/HeliOS.conf
           sed -i '/^OPTIMIZE_OUTPUT_FOR_C .*/d' ${{github.workspace}}/temp/HeliOS.conf
@@ -119,13 +119,13 @@ jobs:
       - name: Resize HeliOS logo...
         shell: bash
         run: |
-          convert -resize 2600 ${{github.workspace}}/extras/HeliOS_OG_Logo.png ${{github.workspace}}/temp/HeliOS_OG_Logo.png
+          convert -resize 1600 ${{github.workspace}}/extras/HeliOS_OG_Logo_Light.png ${{github.workspace}}/temp/HeliOS_OG_Logo_Light.png
 
       - name: Generate LaTeX...
         shell: bash
         run: |
           doxygen ${{github.workspace}}/temp/HeliOS.conf
-          sed -i 's~^\\begin{center}\%~\\begin{center}\%\n\\includegraphics{HeliOS_OG_Logo.png}\\\\\n\\vspace*{1cm}~' ${{github.workspace}}/temp/latex/refman.tex
+          sed -i 's~^\\begin{center}\%~\\begin{center}\%\n\\includegraphics{HeliOS_OG_Logo_Light.png}\\\\\n\\vspace*{1cm}~' ${{github.workspace}}/temp/latex/refman.tex
           sed -i 's~Generated by Doxygen [0123456789]*.[0123456789]*.[0123456789]*~HeliOS Developer\x27s Guide~' ${{github.workspace}}/temp/latex/refman.tex
           sed -i 's~Generated by Doxygen~(C)Copyright 2020-2023 HeliOS Project~' ${{github.workspace}}/temp/latex/refman.tex
 

.github/workflows/HeliOS_CI_Workflow.yml

@@ -30,7 +30,7 @@
     "custom"
   ],
   "doxdocgen.file.fileTemplate": "@file {name}",
-  "doxdocgen.file.versionTag": "@version 0.4.0",
+  "doxdocgen.file.versionTag": "@version 0.4.1",
   "doxdocgen.generic.authorEmail": "manny@heliosproj.org",
   "doxdocgen.generic.authorName": "Manny Peterson",
   "doxdocgen.generic.authorTag": "@author {author} <{email}>",

.vscode/settings.json

@@ -1,7 +1,7 @@
 
 # Code of Conduct
 
-The [HeliOS Project](https://github.com/heliosproj) has a very simple, yet strict, Code of Conduct. If you are unable to follow the Code of Conduct, you will be blocked from the [HeliOS Project's](https://github.com/heliosproj) GitHub organization and its repositories indefinitely.
+The [HeliOS Project](https://github.com/heliosproj) has a straight forward Code of Conduct. If you are unable to follow the Code of Conduct, you will be blocked from the [HeliOS Project's](https://github.com/heliosproj) GitHub organization and its repositories indefinitely. All members of the [HeliOS Project](https://github.com/heliosproj) community are expected to:
 
 1. Adhere to the [GitHub Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service)
 2. Treat others as you wish to be treated yourself (i.e., act as if you are a mature adult human being by treating others with respect and dignity)

CODE_OF_CONDUCT.md

@@ -1,5 +1,5 @@
 # Contributing to HeliOS
-We love that you are interested in joining the HeliOS Project community by contributing to HeliOS. We want to make contributing to this project as easy and seamless as possible, whether it is:
+We love that you are interested in joining the HeliOS Project community as a contributor. We want to make contributing to the project as easy and seamless as possible, whether it is:
 
 - Reporting a bug
 - Submitting a bug fix
@@ -10,29 +10,32 @@ We love that you are interested in joining the HeliOS Project community by contr
 - Becoming a maintainer
 
 ## We Develop with Github
-The HeliOS Project uses GitHub exclusively to maintain a develop HeliOS. The primary methods for contributing to HeliOS are through GitHub Issues and Pull Requests (i.e., PRs).
+The HeliOS Project uses GitHub exclusively to maintain and develop HeliOS. The best methods for engaging with the HeliOS Project is through GitHub Issues and Pull Requests.
 
 Submit a:
-- **Issue**: If you are reporting a bug, asking a question or proposing a new feature, then submit an issue. Please do not submit source code or other file changes through an issue. If you do, you will be asked to submit a pull request and your issue will be closed. See the **Submitting an Issue** section below for more details.
-- **Pull Request**: If you are submitting a bug fix, a new feature or a documentation change, then submit a pull request. See the **Submitting a Pull Request** section below for more details.
+- **Issue**: If you are reporting a bug, asking a question or proposing a new feature, then submit an issue. Please do not submit source code or other file changes through an issue. If you do, you will be asked to submit a pull request and your issue will be closed. See the **Submitting an Issue** section below for more details on submitting an issue.
+- **Pull Request**: If you are submitting a bug fix or a new feature, then submit a pull request. See the **Submitting a Pull Request** section below for more details.
 
 ## Submitting an Issue
 
-If you are reporting a bug then submit a **Bug Report** issue. Other requests or questions should be submitted using the **Everything Else** issue. If your issue includes formatted text or source code excerpts, please use markdown so your issue is readable. Reading an unformatted source code excerpt is nearly impossible. Please note, the more time you put into submitting a clear and detailed issue, the more helpful we can be to you.
+If you are reporting a bug then submit a **Bug Report** issue. If you are in need of help or seeking support then submit a **Support Request**. Anything else should be submitted as an **Other Request**. To open a new issue, go [here](https://github.com/heliosproj/HeliOS/issues). We kindly ask for your patience as it may take several days before we are able to respond to your issue. If it is a bug report or support request, it may take longer.
 
 ## Submitting a Pull Request
 
-First and foremost, it will take several days before your pull request is merged (if it is merged at all). All pull requests are reviewed multiple times and we may request you make changes before your pull request is merged. Once your pull request is merged, it will not appear in the mainline HeliOS source code until the next release which may be several months away. To submit a pull request, the following **must** be followed:
+First and foremost, it may take a week or more before your pull request is merged (if at all). All pull requests are reviewed multiple times and we may request you make changes before your pull request is merged. Once your pull request is merged, it will not appear in the mainline HeliOS source code until the next release which may be months away. To submit a pull request, the following steps **must** be followed:
 
-1. Fork the repo and create your branch from **develop**. Pull requests opened against the **master** branch will be rejected.
-2. If you have added a new feature, you **must** add unit tests for the new feature. Pull requests for new features not accompanied by unit tests will be rejected.
-3. Your code changes must include code comments (where appropriate) and be accompanied by documentation updates (again, where appropriate).
-4. Ensure all unit tests pass.
-5. Format your code using Uncrustify. The HeliOS Uncrustify config is available [here](/extras/uncrustify/helios.cfg).
-6. Issue that pull request and hang tight! :)
+1. Fork the repository (you must uncheck **[x] Copy the ``main`` branch only.** option before forking the repository) into your personal GitHub account. If you do not perform this step correctly, only the ``master`` branch will be forked and you will have to start over.
+2. Create a new branch named ``develop-<account_name>`` from the ``develop`` branch. **Do not make your changes to the sources in the ``master`` branch (this branch contains the latest release). If you do, your pull request will be rejected.**
+3. Make your source code changes. 
+4. If you have added a new feature, you **must** add unit tests for the new feature. The unit tests are in ``/test``. **Pull requests for new features not accompanied by unit tests will be rejected.**
+5. Changes to source code must include code comments (where appropriate) and be accompanied by documentation updates (again, where appropriate). Most documentation changes are made to the doxygen documentation in ``/src/HeliOS.h`` which is used to auto-generate the HeliOS Developer's Guide.
+6. Run Uncrustify against the source code files. The HeliOS Uncrustify config is available in ``/extras/uncrustify/helios.cfg``.
+7. Ensure your code compiles without warnings and all unit tests pass.
+8. Create a commit and push to the remote.
+9. Last, but most importantly. Create and submit your pull request. Then go have a :beer:.
 
 ## Copyright & License
-In short, when you contribute source code, documentation or other file changes to the HeliOS project, they will fall under the HeliOS Project copyright and license.
+In short, when you contribute source code, documentation or other file changes to the HeliOS project, those contributions will become part of the HeliOS Project license and copyright.
 
 ## Thank You
-Thank you for your contributions to HeliOS.
+Thank you for your contributions to HeliOS. :pray: