How to set up a well-configured repository

# Project Name

Brief description of what this repository contains and its purpose.

## Overview

More detailed explanation of the project, its goals, and what problems it solves.

## Prerequisites

- PowerShell 5.1 or PowerShell 7.x
- Visual Studio Code with PowerShell extension
- Required modules (if any)

## Repository Structure

```text
 📂 Your Repository/
  ├─ 📂 .bin/
  |   └─ 📄 notes.txt                        # Notes, temporary files or sample data
  ├─ 📂 .github/
  |   ├─ 📝 copilot-instructions.md          # GitHub Copilot custom instructions
  |   └─ 📂 instructions/                    # Modular Copilot instruction files
  |       └─ 📝 powershell.instructions.md   # Language and style rules
  ├─ 📂 .vscode/
  |   ├─ 📋 extensions.json                  # Recommended Visual Studio Code extensions
  |   ├─ 📋 settings.json                    # Workspace settings
  |   └─ 📋 tasks.json                       # Task definitions
  ├─ 📂 solution/
  |   ├─ 📁 Modules/                         # PowerShell modules
  |   └─ 📂 Scripts/                         # PowerShell scripts
  |      ├─ 📄 helloWorld.ps1                # Script file
  |      └─ 📝 README.md                     # README for the scripts folder
  └─ 📁 tests/                               # Test files
      └─ 📝 README.md                        # README for the tests folder
```

## Getting Started

1. Clone the repository
2. Open in Visual Studio Code
3. Install recommended extensions when prompted
4. Run scripts using the provided Visual Studio Code tasks

## Scripts

| Script | Description |
|--------|-------------|
| `Script1.ps1` | Description of what it does |
| `Script2.ps1` | Description of what it does |

## Testing

Describe how to run tests for your project. Include the command and any prerequisites.

## Contributing

Guidelines for contributing to this repository.

## License

License information.

MIT License

Copyright (c) [year] [your name]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
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
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
SOFTWARE.

# Contributing to [Project Name]

Thank you for your interest in contributing!

## How to Contribute

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run tests locally
5. Run your linter (e.g., `Invoke-ScriptAnalyzer -Path ./src -Recurse` for PowerShell)
6. Commit your changes (`git commit -m 'Add amazing feature'`)
7. Push to the branch (`git push origin feature/amazing-feature`)
8. Open a Pull Request

## Coding Standards

- Follow the conventions in `.github/copilot-instructions.md`
- Include documentation for all functions
- Add tests for new functionality
- Follow the project's code quality guidelines

## Reporting Issues

Use GitHub Issues to report bugs or request features. Please include:

- PowerShell version (`$PSVersionTable`)
- Operating system
- Steps to reproduce the issue
- Expected vs actual behavior

# Security Policy

## Reporting a Vulnerability

If you discover a security vulnerability in this project, please report it responsibly:

1. **Do not** open a public GitHub issue
2. Email [[email protected]] with details
3. Include steps to reproduce the vulnerability
4. Allow reasonable time for a fix before public disclosure

## Security Best Practices

When using scripts from this repository:

- Review scripts before running them
- Never run scripts with elevated privileges unless necessary
- Do not hardcode credentials - use secure credential storage
- Test in a non-production environment first

Analyze this entire workspace and generate a complete .github/copilot-instructions.md file.

Your output should:
- Identify the purpose, architecture, and conventions used in this repository
- Infer coding patterns, naming conventions, folder structure, and design principles
- Detect frameworks, libraries, and tools in use
- Identify any implicit rules the codebase follows (style, patterns, do/don't rules)
- Provide guidance for how Copilot should write code, documentation, tests, and comments in this repo
- Include examples of good patterns to follow and bad patterns to avoid

Format the result as a polished, production-ready copilot-instructions.md file with clear sections, headings, and examples.

# Copilot Instructions for [Project Name]

**Purpose**: These instructions guide GitHub Copilot when working in this repository.

---

## Project Overview

This repository contains PowerShell scripts for [describe purpose].
Target environment: [Windows 10/11, Microsoft Intune, etc.]

## File Standards

- **Encoding**: UTF-8 for all files
- **Line endings**: LF (`\n`) - never CRLF
- **Final newline**: Always insert final newline
- **Trailing whitespace**: Trim trailing whitespace

## PowerShell Standards

### Script Header Comments

All scripts must include header comments:

```powershell
# Description: Brief explanation of what the script does
# Elevation: Administrator | User | SYSTEM - Reason why this level is required
```

### Coding Conventions

- Use approved verbs for function names (Get, Set, New, Remove, etc.)
- Use PascalCase for function names and parameters
- Use $camelCase for local variables
- Always use `[CmdletBinding()]` for advanced functions
- Include comment-based help for all functions
- Use full cmdlet names, not aliases (e.g., `Where-Object` not `?`)

### Constrained Language Mode Compatibility

Scripts may run in Constrained Language Mode (CLM). Follow these rules:

- Avoid `Add-Type` with inline C# code
- Do not use `[scriptblock]::Create()`
- Avoid `New-Object -ComObject`
- Use cmdlets instead of .NET methods where possible
- Test scripts with `$ExecutionContext.SessionState.LanguageMode = 'ConstrainedLanguage'`

## Testing Requirements

- All code should have corresponding tests
- Follow consistent test file naming conventions
- Tests should cover success paths and error handling

## Security Considerations

- Never hardcode credentials or secrets
- Use `SecureString` for sensitive data
- Validate all input parameters
- Follow the principle of least privilege for elevation requirements

 📂 Your Repository/
  └─📂 .github/
     ├─📂 instructions/
     |  ├─ 📝 coding-style.instructions.md
     |  ├─ 📝 architecture.instructions.md
     |  ├─ 📝 testing.instructions.md
     |  ├─ 📝 documentation.instructions.md
     |  ├─ 📝 commit-messages.instructions.md
     |  └─ 📝 security.instructions.md
     └─ 📝 copilot-instructions.md

# Coding Style Guidelines

## General Rules

- Match the language and framework conventions already present in the repository.
- Use consistent naming conventions for files, variables, functions, and classes.
- Follow formatting rules enforced by linters or formatters.

## PowerShell-Specific Rules

- Use approved verbs for function names (`Get`, `Set`, `New`, `Remove`).
- Use PascalCase for function names and parameters.
- Use $camelCase for local variables.
- Use full cmdlet names, not aliases (e.g., `Where-Object` not `?`).

## Examples

Good:
- Clear, descriptive names
- Small, focused functions

Bad:
- Abbreviations without context
- Large functions doing multiple things

Analyze this entire workspace and generate content for both:
1. .github/copilot-instructions.md
2. The .github/instructions/ folder (modular instruction files)

Suggest a modular breakdown for the .github/instructions/ folder and generate
a short, clear, reusable set of instructions for each file.

{
  "recommendations": [
    // PowerShell development
    "ms-vscode.powershell",

    // AI assistance
    "github.copilot",
    "github.copilot-chat",

    // Code quality
    "streetsidesoftware.code-spell-checker",

    // Git integration
    "eamodio.gitlens"
  ],
  "unwantedRecommendations": []
}

{
  // File handling
  "files.encoding": "utf8",
  "files.eol": "\n",
  "files.trimTrailingWhitespace": true,
  "files.insertFinalNewline": true,

  // Editor behavior
  "editor.formatOnSave": true,
  "editor.renderWhitespace": "boundary",
  "editor.rulers": [120],

  // PowerShell-specific settings
  "[powershell]": {
    "editor.tabSize": 4,
    "editor.insertSpaces": true,
    "editor.detectIndentation": false,
    "editor.wordWrap": "off",
    "files.encoding": "utf8",
    "files.eol": "\n"
  },

  // PowerShell extension settings
  "powershell.codeFormatting.preset": "OTBS",
  "powershell.codeFormatting.alignPropertyValuePairs": true,
  "powershell.codeFormatting.useConstantStrings": true,
  "powershell.codeFormatting.whitespaceBetweenParameters": true,
  "powershell.scriptAnalysis.enable": true,
  "powershell.scriptAnalysis.settingsPath": "./PSScriptAnalyzerSettings.psd1",

  // Terminal settings
  "terminal.integrated.defaultProfile.windows": "PowerShell",

  // Files to exclude from explorer
  "files.exclude": {
    "**/.git": true,
    "**/node_modules": true
  }
}

{
  "version": "2.0.0",
  "tasks": [
    // Run current script in PowerShell (64-bit)
    {
      "label": "PowerShell: Run Script (64-bit)",
      "type": "shell",
      "command": "powershell.exe",
      "args": [
        "-NoProfile",
        "-ExecutionPolicy", "Bypass",
        "-File", "${file}"
      ],
      "problemMatcher": ["$msCompile"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "presentation": {
        "reveal": "always",
        "panel": "shared",
        "clear": true
      }
    },
    // Run current script in PowerShell (32-bit)
    {
      "label": "PowerShell: Run Script (32-bit)",
      "type": "shell",
      "command": "${env:SystemRoot}\\SysWOW64\\WindowsPowerShell\\v1.0\\powershell.exe",
      "args": [
        "-NoProfile",
        "-ExecutionPolicy", "Bypass",
        "-File", "${file}"
      ],
      "problemMatcher": ["$msCompile"],
      "presentation": {
        "reveal": "always",
        "panel": "shared",
        "clear": true
      }
    },
    // Run current script in Constrained Language Mode
    {
      "label": "PowerShell: Run Script (Constrained Language Mode)",
      "type": "shell",
      "command": "powershell.exe",
      "args": [
        "-NoProfile",
        "-ExecutionPolicy", "Bypass",
        "-Command",
        "$ExecutionContext.SessionState.LanguageMode = 'ConstrainedLanguage'; & '${file}'"
      ],
      "problemMatcher": ["$msCompile"],
      "presentation": {
        "reveal": "always",
        "panel": "shared",
        "clear": true
      }
    },
    // Run current script in PowerShell 7
    {
      "label": "PowerShell: Run Script (PowerShell 7)",
      "type": "shell",
      "command": "pwsh.exe",
      "args": [
        "-NoProfile",
        "-ExecutionPolicy", "Bypass",
        "-File", "${file}"
      ],
      "problemMatcher": ["$msCompile"],
      "presentation": {
        "reveal": "always",
        "panel": "shared",
        "clear": true
      }
    },
    // Run PSScriptAnalyzer on current file
    {
      "label": "PSScriptAnalyzer: Analyze Current File",
      "type": "shell",
      "command": "powershell.exe",
      "args": [
        "-NoProfile",
        "-ExecutionPolicy", "Bypass",
        "-Command",
        "Invoke-ScriptAnalyzer -Path '${file}' -Recurse -ReportSummary"
      ],
      "problemMatcher": ["$msCompile"],
      "presentation": {
        "reveal": "always",
        "panel": "shared",
        "clear": true
      }
    },
    // Run PSScriptAnalyzer on entire repository
    {
      "label": "PSScriptAnalyzer: Analyze All Scripts",
      "type": "shell",
      "command": "powershell.exe",
      "args": [
        "-NoProfile",
        "-ExecutionPolicy", "Bypass",
        "-Command",
        "Invoke-ScriptAnalyzer -Path './src' -Recurse -ReportSummary"
      ],
      "problemMatcher": ["$msCompile"],
      "presentation": {
        "reveal": "always",
        "panel": "shared",
        "clear": true
      }
    }
  ]
}

{
  "Script header comment": {
    "scope": "powershell",
    "prefix": "scriptheader",
    "body": [
      "# Description: $1",
      "# Elevation: ${2|is not required,is required|} - $3"
    ],
    "description": "Insert standard script header comment"
  },
  "CmdletBinding function": {
    "scope": "powershell",
    "prefix": "cmdletfunction",
    "body": [
      "function ${1:Verb-Noun} {",
      "    [CmdletBinding()]",
      "    param (",
      "        [Parameter(Mandatory = \\$true)]",
      "        [string]\\$${2:ParameterName}",
      "    )",
      "",
      "    begin {",
      "        $0",
      "    }",
      "",
      "    process {",
      "    }",
      "",
      "    end {",
      "    }",
      "}"
    ],
    "description": "Insert a CmdletBinding function template"
  }
}

# Folders
bin/
obj/

# PowerShell
*.log
*.tmp
*_log.txt

# Module output
/output/
/release/

# VS Code
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/extensions.json
!.vscode/*.code-snippets

# OS files
Thumbs.db
ehthumbs.db
Desktop.ini
.DS_Store

# Credential files - NEVER commit these
*.pfx
*.cer
*.pem
credentials.json
secrets.json

# Set default behavior to automatically normalize line endings
* text=auto eol=lf

# PowerShell files
*.ps1 text eol=lf
*.psm1 text eol=lf
*.psd1 text eol=lf
*.ps1xml text eol=lf

# Documentation
*.md text eol=lf
*.txt text eol=lf

# Configuration files
*.json text eol=lf
*.xml text eol=lf
*.yml text eol=lf
*.yaml text eol=lf

# Shell scripts
*.sh text eol=lf
*.bash text eol=lf

# Windows batch files - keep CRLF
*.bat text eol=crlf
*.cmd text eol=crlf

# Binary files
*.exe binary
*.dll binary
*.zip binary
*.png binary
*.jpg binary
*.ico binary

# EditorConfig is awesome: https://EditorConfig.org
root = true

# Default settings for all files
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4

# PowerShell files
[*.{ps1,psm1,psd1}]
indent_size = 4

# Configuration files
[*.{json,yml,yaml}]
indent_size = 2

# Markdown files
[*.md]
indent_size = 2
trim_trailing_whitespace = false

# Batch files - Windows line endings
[*.{bat,cmd}]
end_of_line = crlf

 📂 Your Repository/
  ├─ 📂 .bin/
  |   └─ 📄 notes.txt                        # Notes, temporary files or sample data
  ├─ 📂 .github/
  |   ├─ 📂 instructions/                    # Modular Copilot instruction files
  |   |   └─ 📝 coding-style.instructions.md # Language and style rules
  |   └─ 📝 copilot-instructions.md          # GitHub Copilot custom instructions
  ├─ 📂 .vscode/
  |   ├─ 📋 extensions.json                  # Recommended Visual Studio Code extensions
  |   ├─ 📋 settings.json                    # Workspace settings
  |   ├─ 📄 snippets.code-snippets           # Workspace code snippets
  |   └─ 📋 tasks.json                       # Task definitions
  ├─ 📂 solution/
  |   ├─ 📁 Modules/                         # PowerShell modules
  |   └─ 📂 Scripts/                         # PowerShell scripts
  |       ├─ 📄 helloWorld.ps1               # Script file
  |       └─ 📝 README.md                    # Read me file for the scripts folder
  ├─ 📁 tests/                               # Test files
  ├─ 📝 README.md                            # Repository README
  ├─ 📄 .editorconfig                        # Cross-editor configuration
  ├─ 📄 .gitattributes                       # Git line ending configuration
  ├─ 📄 .gitignore                           # Files to exclude from Git
  ├─ 📝 CONTRIBUTING.md                      # Contribution guidelines
  ├─ 📄 LICENSE                              # License file
  └─ 📝 SECURITY.md                          # Security policy