Skip to content

Commit fc720af

Browse files
Update README and add dependencies documentation; enhance development workflow resources
1 parent 4f1a9de commit fc720af

File tree

3 files changed

+44
-75
lines changed

3 files changed

+44
-75
lines changed

README.md

Lines changed: 22 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ you can clone this repository and start writing your module's business logic imm
1616

1717
**Perfect for:**
1818

19-
- 📦 Open-source PowerShell projects
20-
- 🔧 DevOps automation tools
21-
- 🎓 Learning PowerShell module development best practices
19+
- Open-source PowerShell projects
20+
- Rapid prototyping of PowerShell modules
21+
- Learning PowerShell module development best practices
2222

2323
## 🎬 How to Use This Template
2424

@@ -27,46 +27,34 @@ you can clone this repository and start writing your module's business logic imm
2727
1. Wait **about 20 seconds** for the automated bootstrap workflow to complete
2828
1. **Refresh the page** to see your customized repository
2929

30-
The bootstrap process will:
31-
32-
- Rename all files and references from `PSScriptModule` to your module name
33-
- Update the module manifest with your description
34-
- Remove template-specific files
35-
- Initialize your module's structure
36-
3730
[![](https://img.shields.io/badge/Use%20Powershell%20Template-%E2%86%92-1f883d?style=for-the-badge&logo=github&labelColor=197935)](https://github.com/new?template_owner=WarehouseFinds&template_name=PSScriptModule&owner=%40me&name=MyProject&description=PS%20Module%20Template&visibility=public)
3831

32+
## 📦 Features
3933

40-
## � What You Get Out of the Box
41-
42-
When you create a module from this template, you immediately have:
34+
When you create a module from this template, you immediately get:
4335

4436
**CI/CD Ready**
4537

46-
- GitHub Actions workflows for CI, release, and publishing
38+
- GitHub Actions workflows for CI, release, publishing and more
4739
- Dependency management and caching
48-
- Code quality gates that must pass before merging
49-
- GitHub release and changelog generation based on merged PRs
40+
- Compatibility testing on Windows, Linux, and macOS
41+
- Automated publishing to PowerShell Gallery and NuGet.org
5042

5143
**Development Environment**
5244

53-
- VS Code workspace configuration
45+
- VS Code configuration (settings, recommended extensions)
5446
- Build tasks pre-configured
55-
- Devcontainer support for consistent environments
47+
- Run and debug configurations
48+
- Devcontainer support for preconfigured sandboxed environments
5649

5750
**Version Management**
5851

5952
- GitVersion for semantic versioning
6053
- GitHub Flow (v1) release workflow
6154
- Commit-based version bumps with `+semver:` keywords
62-
- Automated module manifest version updates
63-
64-
**Release Management**
55+
- Changelog generation based on merged PRs
6556

66-
- GitHub Releases with changelog generation
67-
- Automated publishing to PowerShell Gallery
68-
69-
**Complete Testing Infrastructure**
57+
**Code Quality and Testing**
7058

7159
- Pester test framework for unit tests
7260
- Code coverage reporting
@@ -164,22 +152,13 @@ After setup, customize your module:
164152

165153
> **Note**: Do not change `ModuleVersion`, `RootModule` and `FunctionsToExport` - it is managed automatically
166154
167-
1. **Update Documentation**:
168-
- Customize this README.md
169-
- Update [CONTRIBUTING.md](CONTRIBUTING.md) with your contribution guidelines
170-
- Review and update documentation in `/docs` folder
171-
172-
1. **Configure Publishing** (optional):
173-
- Register on [PowerShell Gallery](https://www.powershellgallery.com/) and create an API key
174-
- Add PowerShell Gallery API key in repository secrets
175-
- Review `.github/workflows/release.yml` for publishing settings
176-
177155
1. **Start Developing**:
178156
- Add functions to `src/Public/` (exported) or `src/Private/` (internal)
179157
- Create corresponding `.Tests.ps1` files
180158

181159
1. **Push your changes** and open a pull request to trigger CI/CD workflows
182160

161+
## Documentation
183162

184163
See the [documentation guides](docs/) for detailed information on:
185164

@@ -190,53 +169,21 @@ See the [documentation guides](docs/) for detailed information on:
190169

191170
## 🤝 Contributing
192171

193-
We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) guide for:
172+
We welcome contributions! Please see our [CONTRIBUTING](CONTRIBUTING.md) guide for:
194173

195-
- How to report issues
196174
- Pull request process
197175
- Code style guidelines
198176
- Testing requirements
199177

200-
## 📋 Dependencies
201-
202-
This template uses the following PowerShell modules:
178+
## Like this project?
203179

204-
| Module | Version | Purpose |
205-
| --------- | ---------------- | --------- |
206-
| **InvokeBuild** | 5.14.22 | Build orchestration |
207-
| **ModuleBuilder** | 3.1.8 | Module compilation |
208-
| **Pester** | 5.7.1 | Testing framework |
209-
| **PSScriptAnalyzer** | 1.24.0 | Static code analysis |
210-
| **InjectionHunter** | 1.0.0 | Security vulnerability scanning |
211-
| **Microsoft.PowerShell.PlatyPS** | 1.0.1 | Help documentation generation |
180+
If you find this template useful, please consider supporting it by:
212181

213-
All dependencies are managed through `requirements.psd1` and can be installed with PSDepend.
214-
215-
## 📝 License
216-
217-
This project is licensed under the terms specified in the [LICENSE](LICENSE) file.
218-
219-
## 🎓 Learning Resources
220-
221-
- [PowerShell Best Practices](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/cmdlet-development-guidelines)
222-
- [Pester Documentation](https://pester.dev/)
223-
- [PSScriptAnalyzer Rules](https://github.com/PowerShell/PSScriptAnalyzer)
224-
- [Semantic Versioning](https://semver.org/)
225-
- [GitHub Flow](https://guides.github.com/introduction/flow/)
226-
227-
## 🆘 Support
228-
229-
- 📖 Check the [CONTRIBUTING.md](CONTRIBUTING.md) guide
230-
- 📚 Browse the [documentation](docs/) for detailed guides
231-
- 🐛 [Report issues](https://github.com/WarehouseFinds/PSScriptModule/issues)
232-
- 💬 [Start a discussion](https://github.com/WarehouseFinds/PSScriptModule/discussions)
182+
- **Star this repository** if you find it useful
183+
- **Share it** with other PowerShell developers
184+
- **Provide feedback** via issues or discussions
185+
- **Sponsor development** via GitHub Sponsors
233186

234187
---
235188

236-
## 🚀 Ready to Start?
237-
238-
1. **[Create your module from this template →](https://github.com/new?template_owner=WarehouseFinds&template_name=PSScriptModule)**
239-
1. **Star this repository** if you find it useful
240-
1. **Share it** with other PowerShell developers
241-
242-
**Built with ❤️ by [Warehouse Finds](https://github.com/WarehouseFinds)**
189+
Built with ❤️ by [Warehouse Finds](https://github.com/WarehouseFinds)

docs/dependencies.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# 📋 Dependencies
2+
3+
This template uses the following PowerShell modules:
4+
5+
| Module | Version | Purpose |
6+
| --------- | ---------------- | --------- |
7+
| **InvokeBuild** | 5.14.22 | Build orchestration |
8+
| **ModuleBuilder** | 3.1.8 | Module compilation |
9+
| **Pester** | 5.7.1 | Testing framework |
10+
| **PSScriptAnalyzer** | 1.24.0 | Static code analysis |
11+
| **InjectionHunter** | 1.0.0 | Security vulnerability scanning |
12+
| **Microsoft.PowerShell.PlatyPS** | 1.0.1 | Help documentation generation |
13+
14+
All dependencies are managed through `requirements.psd1` and can be installed with PSDepend.

docs/development.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,11 @@
6868
1. Commit with semver keyword: `git commit -m "Add feature +semver: minor"`
6969
1. Push and create Pull Request
7070
1. After PR merge, automatic release is triggered
71+
72+
## 🎓 Learning Resources
73+
74+
- [PowerShell Best Practices](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/cmdlet-development-guidelines)
75+
- [Pester Documentation](https://pester.dev/)
76+
- [PSScriptAnalyzer Rules](https://github.com/PowerShell/PSScriptAnalyzer)
77+
- [Semantic Versioning](https://semver.org/)
78+
- [GitHub Flow](https://guides.github.com/introduction/flow/)

0 commit comments

Comments
 (0)