- Updated PULL_REQUEST_TEMPLATE.md to reference only pertinent inform…

…ation. - Updated bug_report.md to better capture all the required info as well as fixed a formatting issue. - updated feature_request.md.template and feature_request.md with REQUIRED and OPTIONAL after the respective headings. - updated technical_task.md.template and technical_task.md with REQUIRED and OPTIONAL after the respective headings.
jason-c-daniels · Aug 5, 2022 · 1258f85 · 1258f85
1 parent 04eae84
commit 1258f85
Show file tree

Hide file tree

Showing 13 changed files with 61 additions and 61 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,41 +4,44 @@ about: Create a report to help drive improvements
 
 ---
 
-### Bug Description
+### Bug Description (REQUIRED)
 
-A clear and concise description of what the bug is.
+A clear and concise description of what the problematic behavior.
 
-### (OPTIONAL) Data Setup/Scenario Description
+### Data Setup/Scenario Description (OPTIONAL)
 
 A description of where/how to begin reproducing the bug. (i.e. In order to successfully reproduce the issue,
-what state does the shell need to be in? For example: Set GITHUB_TOKEN to a bad value...etc.) 
+what state does the shell need to be in? For example: Set GITHUB_TOKEN to a bad value...etc.)
 
-### Steps To Reproduce
+### Steps To Reproduce (REQUIRED)
 
 *List the steps to Reproduce the behavior:*
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 
-### Observed Results
+### Observed Results (REQUIRED)
 
-A clear and concise description of the results from executing the Steps to Reproduce. 
+A clear and concise description of the results from executing the Steps to Reproduce.
 
-### Expected Results
+### Expected Results (REQUIRED)
 
 A clear and concise description of what you expected to happen instead.
 
 
-### Console Output/Log Files
+### Console Output/Log Files (OPTIONAL)
 
 If applicable, add console output/log files to help explain the problem.
 
-**Desktop (please complete the following information):**
+### Execution Environment (REQUIRED)
 
- - OS: [e.g. Debian 10, Windows 11]
- - Subsystem: [e.g. MSYS2, Git Bash, WSL2]
- - Shell: [e.g. bash, zsh ]
- - Version: [e.g. 0.0.3-alpha]
+- jcd-new Version: [e.g. 0.0.3-alpha]
+- OS: [e.g. Debian 10, Windows 11]
+- Subsystem: [e.g. MSYS2, Git Bash, WSL2]
+- Shell: [e.g. bash, zsh ]
+- Git Version: [e.g. 2.33.1.windows.1]
+- GH Version: [e.g. version 2.14.3 (2022-07-26)]
+- Dotnet Commandline Version: [e.g. 6.0.302]
 
 ### Additional Context
 

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,14 +4,14 @@ about: Suggest an idea for this project
 
 ---
 
-### Request Summary
+### Request Summary (REQUIRED)
 A clear and concise description of the new feature you wish to have implemented.
 
-### Proposed Resolution
-A clear and concise description of what you want to happen.
+### Proposed Resolution (REQUIRED)
+A clear and concise description of how you want it to happen.
 
-### Alternatives
+### Alternatives (REQUIRED)
 A clear and concise description of any alternative solutions or features you've considered.
 
-### Additional context
+### Additional context (OPTIONAL)
 Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/technical_task.md b/.github/ISSUE_TEMPLATE/technical_task.md
@@ -4,18 +4,18 @@ about: Create a request to have some technical task performed or technical featu
 
 ---
 
-### Task Description
+### Task Description (REQUIRED)
 
 A clear and concise description of what to do. (e.g. Refactor Feature to eliminate all ShellCheck warnings and errors)
 
-### (OPTIONAL) Acceptance Criteria
+### Acceptance Criteria (OPTIONAL)
 
 A clear and concise description of how one determines it's been done (if not immediately apparent).
 
-### Motivation
+### Motivation (REQUIRED)
 
 A clear and concise description of why this is being requested.
 
-### Additional Context
+### Additional Context (OPTIONAL)
 
 Add any other context about the request here.
diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md
@@ -3,7 +3,7 @@ name: User Story
 about: This template provides a basic structure for user stories.
 
 ---
-*The title should be a concise summary of the nature of the story, **NOT the story itself.***
+*The title should be a concise summary of the nature of the story, **NOT the story itself. All sections are required. ***
 
 ### User Story
 As a ROLE-GOES-HERE, I want to SOME-ACTION-OR-SHORT-LIST-OF-ACTIONS, so I can THE-END-GOAL-OF-THE-ACTIONS

diff --git a/LICENSE b/LICENSE
@@ -14,7 +14,7 @@ copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -1,8 +1,6 @@
-# Pull Request Template
-
 ## Description
 
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. 
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
 List any dependencies that are required for this change.
 
 Fixes # (issue)
@@ -18,17 +16,15 @@ Please delete options that are not relevant.
 
 ## How Has This Been Tested?
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also 
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
 list any relevant details for your test configuration
 
 - [ ] Test A
 - [ ] Test B
 
 **Test Configuration**:
-* Firmware version:
-* Hardware:
-* Toolchain:
-* SDK:
+* OS:
+* Shell:
 
 ## Checklist:
 

diff --git a/release.sh b/release.sh
@@ -3,7 +3,7 @@
 set -e
 
 # get the location where this script is running from.
-THIS_DIR=$(dirname $(readlink -f "$0"))
+THIS_DIR=$(dirname "$(readlink -f "$0")")
 
 # if no destination specified notify the user the current directory will be used.
 DEST_DIR="$1"

diff --git a/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/bug_report.md.template b/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/bug_report.md.template
@@ -4,55 +4,55 @@ about: Create a report to help drive improvements
 
 ---
 
-### Bug Description
+### Bug Description (REQUIRED)
 
 A clear and concise description of what the bug is.
 
-### (OPTIONAL) Data Setup/Scenario Description
+### Data Setup/Scenario Description (OPTIONAL)
 
 A description of where/how to begin reproducing the bug. (i.e. In order to successfully
 reproduce the issue, what state does the system need to be in?)
 
-### Steps To Reproduce
+### Steps To Reproduce (REQUIRED)
 
 *List the steps to Reproduce the behavior:*
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 
-### Observed Results
+### Observed Results (REQUIRED)
 
 A clear and concise description of what you expected to see after the last step in Steps to Reproduce.
 
-### Expected Results
+### Expected Results (REQUIRED)
 
 A clear and concise description of what you expected to happen.
 
 
-### Screenshots
+### Screenshots (OPTIONAL)
 
 If applicable, add screenshots to help explain the problem.
 
-### Console Output/Log Files
+### Console Output/Log Files (OPTIONAL)
 
 If applicable, add console output and/or log files to help explain the problem.
 
 
 # TODO: Customize your own set of environment information that you want to capture. This may vary per project.
 
-### Desktop (please complete the following information)
+### Desktop Environment (please complete the following information)
 
- - OS: [e.g. Debian 10, Windows 11]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+- {PROJECT_NAME} Version: [e.g. 0.0.1]
+- OS: [e.g. Debian 10, Windows 11]
+- Browser [e.g. chrome, safari]
 
 ### Smartphone (please complete the following information)
 
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+- {PROJECT_NAME} Version: [e.g. 0.0.1]
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
 
-### Additional Context
+### Additional Context (OPTIONAL)
 
 Add any other context about the problem here.
diff --git a/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/feature_request.md.template b/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/feature_request.md.template
@@ -4,14 +4,14 @@ about: Suggest an idea for this project
 
 ---
 
-### Request Summary
+### Request Summary (REQUIRED)
 A clear and concise description of the new feature you wish to have implemented.
 
-### Proposed Resolution
-A clear and concise description of what you want to happen.
+### Proposed Resolution (REQUIRED)
+A clear and concise description of how you want it to happen.
 
-### Alternatives
+### Alternatives (REQUIRED)
 A clear and concise description of any alternative solutions or features you've considered.
 
-### Additional context
+### Additional context (OPTIONAL)
 Add any other context or screenshots about the feature request here.
diff --git a/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/technical_task.md.template b/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/technical_task.md.template
@@ -4,18 +4,18 @@ about: Create a request to have some technical task performed or technical featu
 
 ---
 
-### Task Description
+### Task Description (REQUIRED)
 
 A clear and concise description of what to do. (e.g. Refactor Feature to eliminate all ShellCheck warnings and errors)
 
-### (OPTIONAL) Acceptance Criteria
+### Acceptance Criteria (OPTIONAL)
 
 A clear and concise description of how one determines it's been done (if not immediately apparent).
 
-### Motivation
+### Motivation (REQUIRED)
 
 A clear and concise description of why this is being requested.
 
-### Additional Context
+### Additional Context (OPTIONAL)
 
 Add any other context about the request here.
diff --git a/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/user_story.md.template b/src/.jcd-new/templates/.github/ISSUE_TEMPLATE/user_story.md.template
@@ -3,7 +3,7 @@ name: User Story
 about: This template provides a basic structure for user stories.
 
 ---
-*The title should be a concise summary of the nature of the story, **NOT the story itself.***
+*The title should be a concise summary of the nature of the story, **NOT the story itself. All sections are required. ***
 
 ### User Story
 As a ROLE-GOES-HERE, I want to SOME-ACTION-OR-SHORT-LIST-OF-ACTIONS, so I can THE-END-GOAL-OF-THE-ACTIONS

diff --git a/src/.jcd-new/templates/LICENSE.template b/src/.jcd-new/templates/LICENSE.template
@@ -14,7 +14,7 @@ copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

diff --git a/src/jcd-new b/src/jcd-new
@@ -27,4 +27,5 @@ main() {
     fi;
 }
 
+# shellcheck disable=SC2068
 main $@
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,4 +27,5 @@ main() { @@
         fi;
     }
+    # shellcheck disable=SC2068
     main $@