Merge pull request #109 from WarehouseFinds/feat/documentation_update

Update documentation and support files; refine issue templates

Author: marko-stanojevic

.github/FUNDING.yml

@@ -2,5 +2,3 @@
 github: marko-stanojevic
 ko_fi: mstanojevic
 buy_me_a_coffee: marko.stanojevic
-liberapay: marko-stanojevic
-custom: ["https://www.paypal.me/mstanojevic84"]

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,8 @@
-blank_issues_enabled: true
+blank_issues_enabled: false
 contact_links:
   - name: Questions & Discussions
-    url: https://github.com/YourUsername/PSScriptModule/discussions
+    url: https://github.com/WarehouseFinds/PSScriptModule/discussions
     about: Ask questions and discuss ideas with the community
   - name: Security Issues
-    url: https://github.com/YourUsername/PSScriptModule/security/advisories/new
+    url: https://github.com/WarehouseFinds/PSScriptModule/security/advisories/new
     about: Report security vulnerabilities privately

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,4 +1,4 @@
-name: Documentation Improvement
+name: Documentation Update
 description: Suggest improvements to documentation
 title: "[Docs]: "
 labels: ["documentation"]
@@ -29,7 +29,7 @@ body:
       label: Location
       description: Where is the documentation issue located?
       placeholder: |
-        - File/Function: [e.g., Get-PSScriptModuleInfo]
+        - File/Function: [e.g., .src/Public/Get-PSScriptModuleInfo]
         - Section: [e.g., EXAMPLES]
     validations:
       required: true

.github/SUPPORT.md

@@ -1,70 +1,49 @@
-# Support
+# Need Help or Support?
 
-## Getting Help
+Thank you for using PSScriptModule!
 
-Thank you for using PSScriptModule! If you need help or have questions, here are the available resources:
+If you need help or have questions, here are the available resources:
 
-### Documentation
+## Documentation
 
 - **[README](../README.md)** - Project overview and quick start guide
 - **[Help Documentation](../docs/help/)** - Detailed cmdlet reference
 - **[AI Agents Guide](../AGENTS.md)** - Guidance for AI-assisted development
 
-### Community Support
+## Community Support
+
+### 🐛 Issues & Feature Requests
+
+Search [existing issues](../../issues) or [create a new issue](../../issues/new) for:
 
-- **GitHub Issues** - Search [existing issues](../../issues) or [create a new issue](../../issues/new) for:
     - Bug reports
     - Feature requests
     - Questions about usage
     - Documentation clarifications
 
-- **GitHub Discussions** - Join [discussions](../../discussions) for:
-    - General questions
-    - Best practices
-    - Community collaboration
-    - Show and tell
-
-### Reporting Issues
-
-When reporting issues, please include:
-
-1. **PowerShell Version**: Output of `$PSVersionTable`
-1. **Module Version**: Output of `Get-Module PSScriptModule`
-1. **Operating System**: Windows, macOS, or Linux distribution
-1. **Steps to Reproduce**: Clear steps to reproduce the issue
-1. **Expected Behavior**: What you expected to happen
-1. **Actual Behavior**: What actually happened
-1. **Error Messages**: Full error output with stack traces if available
-
-### Security Issues
+### 🔒 Security Issues
 
 **Do not report security vulnerabilities through public GitHub issues.**
 
 Please report security vulnerabilities by emailing the project maintainer or using GitHub's private security reporting feature.
 
-### Contributing
-
-Interested in contributing? See our [Contributing Guidelines](CONTRIBUTING.md) for:
-
-- Code of conduct
-- Development setup
-- Pull request process
-- Coding standards
+### 💬 Discussion & Feedback
 
-### Response Times
+Join [discussions](../../discussions) for:
 
-This is a community-driven project. Response times may vary:
+    - General questions
+    - Best practices
+    - Community collaboration
+    - Show and tell
 
-- **Critical bugs**: We aim to respond within 48 hours
-- **General issues**: Usually responded to within 1 week
-- **Feature requests**: Reviewed during regular planning cycles
+## Note
 
-### Additional Resources
+### This project is maintained by volunteers ❤️
 
-- **PowerShell Documentation**: [docs.microsoft.com/powershell](https://docs.microsoft.com/en-us/powershell/)
-- **Pester Documentation**: [pester.dev](https://pester.dev/)
-- **PSScriptAnalyzer**: [github.com/PowerShell/PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer)
+- Please be respectful and patient — maintainers may take some time to respond.
+- We do **not provide professional consulting** through the repo issues.  
+- For enterprise support, consider hiring a PowerShell consultant.
 
 ---
 
-**Note**: This project is maintained by volunteers. Please be patient and respectful when seeking support.
+Thank you for being part of the community! 🚀

.github/release.yml

@@ -6,8 +6,8 @@ changelog:
   categories:
     - title: 💥 Breaking Changes
       labels:
-      - breaking
-      - major
+        - breaking
+        - major
     - title: 🚀 Features
       labels:
         - feature

.github/workflows/bootstrap-repo.yml

@@ -107,15 +107,29 @@ jobs:
           MODULE_PATH=${{ github.repository }}
           rm README.md
           mv .github/README_template.md README.md
-          sed -i "s|{MODULE_NAME}|$MODULE_NAME|g" README.md
+          sed -i "s|PSScriptModule|$MODULE_NAME|g" README.md
           sed -i "s|{MODULE_DESCRIPTION}|$MODULE_DESCRIPTION|g" README.md
           sed -i "s|{MODULE_PATH}|$MODULE_PATH|g" README.md
 
+      - name: Update SUPPORT.md
+        run: |
+          MODULE_NAME=${{ github.event.repository.name }}
+          sed -i "s/PSScriptModule/$MODULE_NAME/g" .githubSUPPORT.md
+
       - name: Update LICENSE
         run: |
           OWNER=${{ github.repository_owner }}
           sed -i "s/Warehouse Finds/$OWNER/g" LICENSE
 
+      - name: Remove FUNDING.yml
+        run: |
+          rm .github/FUNDING.yml
+
+      - name: Update config.yml in ISSUE_TEMPLATE
+        run: |
+          MODULE_PATH=${{ github.repository }}
+          sed -i "s|WarehouseFinds/PSScriptModule|$MODULE_PATH|g" .github/ISSUE_TEMPLATE/config.yml
+
       - name: Update devcontainer.json
         run: |
           MODULE_NAME=${{ github.event.repository.name }}

AGENTS.md

@@ -13,7 +13,7 @@ This document provides guidance for AI coding agents (like GitHub Copilot, Curso
 
 ## Project Structure
 
-```
+```plaintext
 PSScriptModule.Template/
 ├── src/                          # Source code
 │   ├── PSScriptModule.psd1      # Module manifest
@@ -31,26 +31,30 @@ PSScriptModule.Template/
 ## Key Conventions
 
 ### File Naming
+
 - Public functions: `Verb-Noun.ps1` in `src/Public/`
 - Private functions: `VerbNoun.ps1` in `src/Private/`
 - Test files: `*.Tests.ps1` alongside source files
 - Help files: `Verb-Noun.md` in `docs/help/`
 
 ### Function Structure
+
 - Use approved PowerShell verbs (Get, Set, New, Remove, etc.)
 - Include `[CmdletBinding()]` attribute
 - Add comprehensive comment-based help
 - Use parameter validation attributes
 - Follow begin/process/end blocks when appropriate
 
 ### Testing Requirements
+
 - Every function must have corresponding `.Tests.ps1` file
 - Use Pester framework (v5+)
 - Organize tests with Describe/Context/It blocks
 - Test both success and failure scenarios
 - Mock external dependencies
 
 ### Code Quality
+
 - Must pass PSScriptAnalyzer with default rules
 - Follow PSScriptAnalyzerSettings.psd1 configuration
 - Check for security issues (injection attacks, etc.)
@@ -77,7 +81,8 @@ Invoke-Build Invoke-Pester            # Run Pester tests
    - Public functions → `src/Public/Verb-Noun.ps1`
    - Private functions → `src/Private/VerbNoun.ps1`
 
-2. **Function Template**:
+1. **Function Template**:
+
    ```powershell
    function Verb-Noun {
        <#
@@ -128,7 +133,8 @@ Invoke-Build Invoke-Pester            # Run Pester tests
    }
    ```
 
-3. **Create Test File**:
+1. **Create Test File**:
+
    ```powershell
    BeforeAll {
        # Import the function
@@ -154,10 +160,10 @@ Invoke-Build Invoke-Pester            # Run Pester tests
 ### When Modifying Existing Code
 
 1. **Verify Tests**: Ensure existing tests still pass
-2. **Update Tests**: Add new tests for new functionality
-3. **Update Help**: Regenerate markdown help if function signature changes
-4. **Check Analysis**: Run PSScriptAnalyzer to verify compliance
-5. **Semantic Versioning**: Include appropriate `+semver:` keyword in commits
+1. **Update Tests**: Add new tests for new functionality
+1. **Update Help**: Regenerate markdown help if function signature changes
+1. **Check Analysis**: Run PSScriptAnalyzer to verify compliance
+1. **Semantic Versioning**: Include appropriate `+semver:` keyword in commits
 
 ### Code Quality Checklist
 
@@ -177,6 +183,7 @@ Before completing any code changes, verify:
 ### Common Patterns
 
 **Error Handling**:
+
 ```powershell
 try {
     # Operation
@@ -188,11 +195,13 @@ catch {
 ```
 
 **Verbose Output**:
+
 ```powershell
 Write-Verbose "Performing action on $Target"
 ```
 
 **Parameter Validation**:
+
 ```powershell
 [Parameter(Mandatory)]
 [ValidateNotNullOrEmpty()]
@@ -202,6 +211,7 @@ $Path
 ```
 
 **Should Process (for destructive operations)**:
+
 ```powershell
 [CmdletBinding(SupportsShouldProcess)]
 param()
@@ -214,11 +224,13 @@ if ($PSCmdlet.ShouldProcess($Target, "Operation")) {
 ### Dependencies
 
 Install required modules via PSDepend:
+
 ```powershell
 Invoke-PSDepend -Path ./requirements.psd1 -Install -Import -Force
 ```
 
 Key dependencies:
+
 - **InvokeBuild**: Build orchestration
 - **Pester**: Testing framework
 - **PSScriptAnalyzer**: Static code analysis
@@ -229,10 +241,10 @@ Key dependencies:
 - Uses GitVersion with GitHub Flow
 - Every PR merge to `main` creates a new release
 - Control version bumps with commit message keywords:
-  - `+semver: major` - Breaking changes (1.0.0 → 2.0.0)
-  - `+semver: minor` - New features (1.0.0 → 1.1.0)
-  - `+semver: patch` - Bug fixes (1.0.0 → 1.0.1)
-  - `+semver: none` - No version change
+    - `+semver: major` - Breaking changes (1.0.0 → 2.0.0)
+    - `+semver: minor` - New features (1.0.0 → 1.1.0)
+    - `+semver: patch` - Bug fixes (1.0.0 → 1.0.1)
+    - `+semver: none` - No version change
 
 ### Testing Commands
 
@@ -258,15 +270,15 @@ Invoke-ScriptAnalyzer -Path ./src -Recurse
 ## Best Practices for AI Agents
 
 1. **Always run tests** after making changes
-2. **Follow existing patterns** in the codebase
-3. **Don't remove or modify** PSScriptAnalyzer suppressions without understanding them
-4. **Update documentation** when changing function signatures
-5. **Use approved verbs** from `Get-Verb` output
-6. **Avoid aliases** in production code (use full cmdlet names)
-7. **Include examples** in help documentation
-8. **Handle errors explicitly** with try/catch blocks
-9. **Add verbose output** for debugging
-10. **Test edge cases** including null/empty inputs
+1. **Follow existing patterns** in the codebase
+1. **Don't remove or modify** PSScriptAnalyzer suppressions without understanding them
+1. **Update documentation** when changing function signatures
+1. **Use approved verbs** from `Get-Verb` output
+1. **Avoid aliases** in production code (use full cmdlet names)
+1. **Include examples** in help documentation
+1. **Handle errors explicitly** with try/catch blocks
+1. **Add verbose output** for debugging
+1. **Test edge cases** including null/empty inputs
 
 ## Resources
 
@@ -279,6 +291,7 @@ Invoke-ScriptAnalyzer -Path ./src -Recurse
 ## Quick Reference
 
 ### File Operations
+
 ```powershell
 # Create new public function
 New-Item -Path ./src/Public/Get-Something.ps1 -ItemType File
@@ -288,6 +301,7 @@ New-Item -Path ./src/Public/Get-Something.Tests.ps1 -ItemType File
 ```
 
 ### Build Operations
+
 ```powershell
 # Clean build
 Invoke-Build Clean
@@ -303,6 +317,7 @@ Invoke-Build -ReleaseType Release
 ```
 
 ### Module Operations
+
 ```powershell
 # Import module for testing
 Import-Module ./src/PSScriptModule.psd1 -Force

README.md

@@ -1,10 +1,11 @@
-# PSScriptModule.Template
+# PSScriptModule - PowerShell Script Module Template
 
 A production-ready PowerShell script module template designed to streamline the creation, testing, and delivery of enterprise-grade PowerShell modules. This template implements modern DevOps practices,
 automated quality gates, and continuous delivery workflows right out of the box.
 
 [![CI](https://github.com/WarehouseFinds/PSScriptModule/actions/workflows/ci.yml/badge.svg)](https://github.com/WarehouseFinds/PSScriptModule/actions/workflows/ci.yml)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/PSScriptModule.svg)](https://www.powershellgallery.com/packages/PSScriptModule)
+[![Downloads](https://img.shields.io/powershellgallery/dt/PSScriptModule.svg)](https://www.powershellgallery.com/packages/PSScriptModule)
 [![License](https://img.shields.io/github/license/WarehouseFinds/PSScriptModule)](LICENSE)
 
 ## 🎯 Purpose