Merge branch 'SSWConsulting:main' into main

.github/pull_request_template.md

@@ -1,22 +1,22 @@
-<!--- Thanks for contributing to SSW.Rules! -->
-## Reason for change (Issue, Email, conversation + reason, etc)
-<!-- 
-- Example 1 - Relates to #{{ ISSUE NUMBER }}
-- Example 2 - As per my conversation with...
-- Example 3 - Based on email thread, subject...
-- Example 4 - I noticed that... 
--->
-{{ REASON FOR CHANGE - WHAT WAS THE TRIGGER FOR THIS CHANGE }}
+**Tip: Use [SSW Rule Writer GPT](https://chat.openai.com/g/g-cOvrRzEnU-ssw-rules-writer) for help with writing rules 🤖**
+>
+> 1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc)
 
-{{ SUMMARY OF CHANGES }}
+✏️
 
-<!-- 
-Have you seen our Rules to Better Pull Requests?
-https://www.ssw.com.au/rules/rules-to-better-pull-requests/
+> 2. What was changed?
+
+✏️
 
-Please provide a good title and a short description of your pull request
-See https://www.ssw.com.au/rules/write-a-good-pull-request/ for further guidance
+> 3. Did you do pair or mob programming (list names)?
 
-Did you do an over the shoulder review?
-https://www.ssw.com.au/rules/over-the-shoulder-prs 
--->
+✏️
+<!-- E.g. I worked with @gordonbeeming and @sethdailyssw -->
+
+<!-- 
+Check out the relevant rules
+- https://www.ssw.com.au/rules/rules-to-better-pull-requests
+- https://www.ssw.com.au/rules/write-a-good-pull-request
+- https://www.ssw.com.au/rules/over-the-shoulder-prs 
+- https://www.ssw.com.au/rules/do-you-use-co-creation-patterns
+-->

.github/workflows/pr-manage-stale.yml

@@ -145,7 +145,7 @@ jobs:
 
           [Did you know you should avoid merge debt?](https://www.ssw.com.au/rules/merge-debt/)          
 
-          Please review and merge or close. 
+          1. Please action (e.g. get a review) and merge or close 
 
           Thanks!
           "@

.github/workflows/pr-metrics.yml

@@ -22,7 +22,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: microsoft/[email protected].3
+      - uses: microsoft/[email protected].10
         name: PR Metrics
         env:
           PR_METRICS_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/validate-frontmatter-all.yml

@@ -0,0 +1,49 @@
+name: Validate-Frontmatter-in-All-Rules
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  validate-all-frontmatter:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+
+      - name: Find all Markdown files in rules
+        run: |
+          find rules -type f -name '*.md' > all_rules_files.txt
+          echo "Found Markdown files:"
+          cat all_rules_files.txt
+
+      - name: Install dependencies
+        run: |
+          cd scripts/frontmatter-validator
+          npm install
+
+      - name: Validate Frontmatter in Rule Files
+        id: validate_frontmatter
+        run: |
+          node scripts/frontmatter-validator/frontmatter-validator.js --file all_rules_files.txt > validation_results.txt
+
+      - name: Create Job Summary
+        if: always()
+        run: |
+          echo "## Frontmatter Validation Issues" >> $GITHUB_STEP_SUMMARY
+          if [ -s validation_results.txt ]; then
+            cat validation_results.txt >> $GITHUB_STEP_SUMMARY
+          else
+            echo "No validation issues detected." >> $GITHUB_STEP_SUMMARY
+          fi
+

.github/workflows/validate-markdown.yml

@@ -0,0 +1,95 @@
+name: Validate-Markdown
+
+on:
+  pull_request:
+    branches: [ main ]
+    paths:
+      - '**.md'
+
+  workflow_dispatch:
+
+jobs:
+  validate-markdown:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      repository-projects: read
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+
+      - name: Get changed files
+        id: files
+        uses: lots0logs/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Filter and format Markdown files
+        run: |
+          MARKDOWN_FILES=$(echo '${{ steps.files.outputs.all }}' | jq -r '.[] | select(endswith(".md"))' | tr '\n' ' ')
+          echo "MARKDOWN_FILES=$MARKDOWN_FILES" >> $GITHUB_ENV
+
+      - name: Install markdownlint-cli
+        run: npm install -g markdownlint-cli
+
+      - name: Auto-fix Markdown files
+        run: |
+          markdownlint --fix $MARKDOWN_FILES --config .markdownlint/config.json || true
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add .
+          git commit -m "Auto-fix Markdown files" || true # Commit only if there are changes
+          git push || true # Push only if there was a commit
+          echo "Auto-fix applied"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      # TODO: Make this work on forked branches  
+      - name: Lint Markdown files
+        if: github.event.pull_request.head.repo.fork == false
+        run: |
+          markdownlint $MARKDOWN_FILES --config .markdownlint/config.json > lint-results.txt 2>&1 || true
+          if [[ -s lint-results.txt ]]; then
+            echo "Linting errors found"
+            cat lint-results.txt
+            echo "LINT_RESULT=$(cat lint-results.txt)" >> $GITHUB_ENV
+            exit 1
+          fi
+
+      - name: Comment on PR with linting errors
+        if: failure() && github.event.pull_request.head.repo.fork == false
+        run: |
+          RULES_DOCS_URL="https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md"
+          PR_NUMBER="${{ github.event.pull_request.number }}"
+          REPO_FULL_NAME="${{ github.repository }}"
+          PR_COMMENT="Hi @${{ github.event.pull_request.user.login }},\n\nWe found some markdown suggestions for your Pull Request:\n\n"
+          PR_COMMENT+="| File | Error | Rule |\n"
+          PR_COMMENT+="| ---- | ----- | ---- |\n"
+          while IFS= read -r line; do
+            FILE_PATH=$(echo "$line" | awk -F: '{print $1}')
+            LINE_NUM=$(echo "$line" | awk -F: '{print $2}')
+            ERROR_DESC=$(echo "$line" | cut -d' ' -f 4- | sed 's/\[.*\]//') # Remove the markdown link from the description
+            RULE_ID=$(echo "$line" | grep -o 'MD[0-9]\+')
+            FILE_NAME=$(basename "$FILE_PATH")
+            FILE_ANCHOR=$(echo "$FILE_NAME" | sed 's/\./-/g')
+            PR_COMMENT+="| [$FILE_PATH](https://github.com/$REPO_FULL_NAME/pull/$PR_NUMBER/files#$FILE_ANCHOR) | Line $LINE_NUM: $ERROR_DESC | [Rule $RULE_ID]($RULES_DOCS_URL#$RULE_ID) |\n"
+          done < lint-results.txt
+          PR_COMMENT+="\nPlease review and update your Markdown files accordingly.\n"
+          echo -e "$PR_COMMENT" > pr_comment.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload PR Comment
+        if: failure() && github.event.pull_request.head.repo.fork == false
+        uses: mshick/add-pr-comment@v2
+        with:
+          message-path: pr_comment.md
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          allow-repeats: true

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 .vscode/settings.json
+.idea

.markdownlint/config.json

@@ -0,0 +1,13 @@
+{
+    "default": true,
+    "MD003": {
+        "style": "atx"
+    },
+    "MD004": {
+        "style": "asterisk"
+    },
+    "MD046": false,
+    "MD013": false,
+    "MD033": false,
+    "MD036": false
+}

categories/application-lifecycle-management-alm/rules-to-better-continuous-deployment-with-tfs.md

@@ -12,7 +12,6 @@ index:
 - do-you-create-a-deployment-project-alongside-your-web-application-for-any-additional-deployment-steps
 - do-you-create-a-continuous-integration-build-for-the-solution-before-configuring-continuous-deployment
 - do-you-create-a-deployment-batch-file-and-setparameters-file-for-each-environment
-- do-you-deploy-to-other-environments
 - do-you-know-the-easiest-way-to-continuously-deploy-is-to-use-visualstudio-com-and-azure
 - do-you-know-to-create-the-website-in-iis-if-using-web-deploy
 - do-you-not-install-web-deploy-from-the-web-platform-installer

categories/application-lifecycle-management-alm/rules-to-better-scrum.md

@@ -33,7 +33,7 @@ index:
   - tasks-do-you-know-to-use-clear-task-descriptions
   - scrum-team-contract
   - tick-and-flick
-  - done-do-you-know-when-to-send-a-done-email-in-scrum
+  - when-to-send-a-done-email-in-scrum
   - done-do-you-know-when-to-do-a-test-please-in-scrum
   - done-do-you-know-how-to-make-sure-you-deliver-a-build-thats-tested-every-sprint
   - do-you-know-how-to-handle-undone-work

categories/application-lifecycle-management-alm/rules-to-better-version-control-with-tfs-aka-source-control.md

@@ -1,6 +1,6 @@
 ---
 type: category
-title: Rules to Better Version Control (AKA Source Control)
+title: Rules to Better Version Control (aka Source Control)
 guid: 432efbab-9580-4b84-afef-16f6bf505e6d
 uri: rules-to-better-version-control-with-tfs-aka-source-control
 redirects:

categories/artificial-intelligence/rules-to-better-gpt.md

@@ -3,20 +3,23 @@ type: category
 title: Rules to Better GPT
 guid: 9e0c432c-4925-4075-a824-5230e0e71354
 uri: rules-to-better-gpt
+consulting: https://www.ssw.com.au/consulting/artificial-intelligence
 index:
 - what-is-chatgpt
 - chatgpt-skills-weaknesses
 - what-is-gpt
 - chatgpt-vs-gpt
 - train-gpt
-- chatgpt-can-help-code
-- chatgpt-can-fix-errors
+- create-gpts
+- use-system-prompt
 - connect-chatgpt-with-virtual-assistant
 - install-chatgpt-as-an-app
-- chatgpt-help-emojis
-- leverage-chatgpt
-- website-chatbot
+- chatgpt-can-help-code
+- chatgpt-can-fix-errors
+- generate-ui-mockups-with-ai
 - use-semantic-kernel
 - use-embeddings
-- use-system-prompt
+- website-chatbot
+- indicate-ai-helped
+- leverage-chatgpt
 ---

categories/communication/rules-to-better-email.md

@@ -6,7 +6,7 @@ uri: rules-to-better-email
 index:
 - dones-is-your-inbox-a-task-list-only
 - dones-do-you-use-email-for-tasks-only-not-communication
-- dones-do-you-reply-done-and-delete-the-original-email
+- reply-done-and-delete-the-email
 - send-to-myself-emails
 - as-per-our-conversation-emails
 - number-tasks-questions
@@ -66,6 +66,7 @@ index:
 - how-to-hand-over-tasks-to-others
 - do-you-know-how-to-reduce-spam
 - do-you-know-not-to-send-attachments-in-emails
+- avoid-using-share-functionality
 - do-you-know-when-to-use-plus-one
 - do-you-manage-your-email-accounts
 - manage-multiple-email-accounts
@@ -76,6 +77,7 @@ index:
 - avoid-using-request-a-receipt
 - do-you-use-active-language-in-your-emails
 - avoid-sarcasm-misunderstanding
+- autocorrect-in-outlook
 - dictate-emails
 - screenshots-do-you-use-balloons-instead-of-a-wall-of-text
 - add-branding-to-screenshots
@@ -91,14 +93,16 @@ index:
 - keep-your-urls-clean
 - storing-contacts
 - following-microsoft-365-groups
+- description-to-the-group
+- highlight-template-differences
 
 ---
 
-Often emails are rambling and unorganized, forcing the reader to wade through blocks of text with low business value. When it comes to written communication, less is more. 
+Often emails are rambling and unorganized, forcing the reader to wade through blocks of text with low business value. When it comes to written communication, less is more.
 
 Having hundreds of emails in your inbox is not uncommon. But it's very uncommon to find people who successfully manage their inbox. Email has a bad name in business primarily because people don't usually treat email correctly.
 
-Emails can be a vital tool to your company and your software development project, but it has to be well managed. Emails should be an accurate record of requests, conversations, and decisions - they are legal documents and should be treated with the same care as any other correspondence with clients or employees. 
+Emails can be a vital tool to your company and your software development project, but it has to be well managed. Emails should be an accurate record of requests, conversations, and decisions - they are legal documents and should be treated with the same care as any other correspondence with clients or employees.
 
 Here is a series of email rules/etiquette that govern how to better manage your emails.
 

categories/communication/rules-to-better-im.md

@@ -21,6 +21,7 @@ index:
 - you-make-the-email-readable-by-snipping-and-formatting-the-im-chat
 - make-the-communication-more-efficient-by-referring-back-to-a-subject-of-an-email
 - close-off-thread
+- separate-messages
 - keep-a-history-of-your-im-conversations
 - better-late-than-never
 - when-to-create-a-group-chat
@@ -36,4 +37,3 @@ index:
 ---
 
 Whether you are chatting to a client on Teams or your friend on WeChat... These are the most common things that can improve your communication.
-

categories/communication/rules-to-better-inbox-management.md

@@ -5,8 +5,9 @@ guid: 11a99a6a-bfd5-49e0-bd02-c109a32e784d
 uri: rules-to-better-inbox-management
 index:
 - clean-your-inbox-per-topics
+- handle-noise-email
 - do-you-save-important-items-in-a-separate-folder
-- dones-do-you-reply-done-and-delete-the-original-email
+- reply-done-and-delete-the-email
 - how-to-hand-over-tasks-to-others
 - do-you-sort-your-emails-by-received-and-important
 - use-conditional-formatting-to-visually-deprioritize-emails

categories/communication/rules-to-better-meetings.md

@@ -19,14 +19,14 @@ index:
 
 ---
 
-Office meetings are often ineffective, because:
+Meetings that lack efficiency frequently occur because:
 
-❌ People are not prepared  
-❌ There is a lot of discussion but no resulting "action items"  
-❌ Rat holes - Time is wasted digressing to unrelated topics  
-❌ People forget the meeting is on and do not attend  
-❌ People turn up late with no notice  
-❌ Meetings go well overtime  
+- People are not prepared  
+- There is a lot of discussion but no resulting "action items"  
+- Rat holes - Time is wasted digressing to unrelated topics  
+- People forget the meeting is on and do not attend  
+- People turn up late with no notice  
+- Meetings go well overtime  
 
 If you have a 1-hour meeting with 5 people in attendance, you're not just wasting 1 hour if it's not productive, your wasting 5 man hours. One hour for each attendee. That's a lot of man hours!
 

categories/communication/rules-to-better-microsoft-teams.md

@@ -5,6 +5,7 @@ guid: 8d4f1557-16a2-4e77-aee7-95c8d3c5123d
 uri: rules-to-better-microsoft-teams
 index:
 - create-a-team
+- connect-client-im
 - teams-naming-conventions
 - use-emojis
 - teams-group-chat
@@ -37,6 +38,7 @@ index:
 - when-to-use-microsoft-teams-preview
 - teams-usage
 - use-microsoft-teams-room
+- use-text-formatting-to-mention-email-subjects
 ---
 
 Microsoft Teams offers a great solution to collaboration using the Office 365 platform. Get ready for a productivity boost, better focus on your work, and increased transparency.

categories/communication/rules-to-better-outlook.md

@@ -6,6 +6,7 @@ uri: rules-to-better-outlook
 index:
 - searching-outlook-effectively
 - minimize-outlook-distractions
+- autocorrect-in-outlook
 - do-you-use-spelling-and-grammar-checker-to-make-your-email-professional
 - avoid-sending-emails-immediately
 - email-send-a-v2