Merge pull request #27 from jdarcyryan/jdr/documentation_update

jdr/documentation_update

Author: jdarcyryan

CODE_OF_CONDUCT.md

@@ -0,0 +1,33 @@
+# Code of Conduct
+
+## Our Pledge
+
+We are committed to providing a welcoming and respectful environment for everyone, regardless of experience level, background, identity, or personal characteristics.
+
+## Our Standards
+
+**Expected behaviour:**
+
+- Being respectful and considerate in communication
+- Providing and accepting constructive feedback graciously
+- Focusing on what is best for the project and community
+- Showing empathy towards other contributors
+
+**Unacceptable behaviour:**
+
+- Harassment, insults, or derogatory comments
+- Personal or political attacks
+- Publishing others' private information without permission
+- Any conduct that would be considered inappropriate in a professional setting
+
+## Scope
+
+This Code of Conduct applies to all project spaces, including issues, pull requests, discussions, and any public representation of the project.
+
+## Enforcement
+
+Instances of unacceptable behaviour may be reported by contacting the project maintainer. All reports will be reviewed and addressed appropriately. The maintainer reserves the right to remove, edit, or reject contributions that violate this Code of Conduct, and to temporarily or permanently ban contributors for behaviour deemed inappropriate.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

CONTRIBUTING.md

@@ -45,6 +45,12 @@ make setup
 ```
 This will set up an example module for testing.
 
+#### Install Dependencies
+```bash
+make depend
+```
+This installs any required modules defined in `PSDepend.psd1`. If your changes add a new module dependency, make sure it is listed in both `PSDepend.psd1` and in `RequiredModules` in the module manifest.
+
 #### Build the Module
 ```bash
 make build
@@ -61,6 +67,7 @@ All tests should pass before submitting your pull request.
 
 - **If you modify Pester tests**: Create example functions and ensure to reference GitHub Actions runs on your forked repository
 - **If you modify scripts or workflows**: Verify that the associated pipelines run correctly in your fork
+- **If you add dependencies**: Ensure they are declared in both `PSDepend.psd1` and `RequiredModules` in the module manifest
 
 ### 6. Commit Your Changes
 

README.md

@@ -12,6 +12,7 @@ Use this template to quickly bootstrap new PowerShell module projects with indus
 - Pre-configured module structure
 - Easy building and testing with make
 - Pester testing framework integration
+- Dependency management with PSDepend
 - GitHub Actions CI/CD workflows
 - C# class support
 - Automatic documentation
@@ -48,6 +49,14 @@ This creates a folder with the repository name, housing the module files/folders
 make setup
 ```
 
+### Installing dependencies
+
+This installs any required modules defined in `PSDepend.psd1` at the root of your repository.
+If no `PSDepend.psd1` file exists, this step is skipped gracefully.
+```bash
+make depend
+```
+
 ### Perform a build
 
 This builds a nupkg from your source code into the .output folder.
@@ -62,6 +71,23 @@ This runs all pester tests against the built module.
 make pester
 ```
 
+## Dependencies
+
+Module dependencies are managed using [PSDepend](https://github.com/RamblingCookieMonster/PSDepend).
+To declare dependencies, create or edit the `PSDepend.psd1` file in the root of your repository.
+
+A simple example that installs the latest version of a module from PSGallery:
+```powershell
+@{
+    'Microsoft.PowerShell.ConsoleGuiTools' = 'latest'
+}
+```
+
+You can also pin versions, use hashtable format for more control, or pull from Git repositories.
+See the comments in the included `PSDepend.psd1` template for all supported options.
+
+Any modules listed in `PSDepend.psd1` should also be added to `RequiredModules` in your module manifest so that PowerShell enforces the dependency at import time.
+
 ## Custom Scripts
 
 For advanced scenarios that fall outside the standard module build process, two custom scripts are available.
@@ -116,4 +142,4 @@ Copyright (c) 2026 James D'Arcy Ryan
 
 ## Acknowledgments
 
-Thank you to all contributors who help improve this template!
+Thank you to all contributors who help improve this template!