Skip to content

Commit 897e1c9

Browse files
kormic911kormic911
authored
Merge pull request #16 from pwshdevs/1.0.10-Features
1.0.10 features expanded unit tests added dryrun functionality, around 80% done added -explain command to devsetup added environment file validation removed a decent amount of code duplication
2 parents 1114b60 + 30a9723 commit 897e1c9

154 files changed

Lines changed: 18293 additions & 9860 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Create a report to help us improve DevSetup
4+
title: '[BUG] '
5+
labels: ['bug', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
**Brief Summary**
12+
<!-- A clear and concise description of what the bug is -->
13+
14+
**Expected Behavior**
15+
<!-- What you expected to happen -->
16+
17+
**Actual Behavior**
18+
<!-- What actually happened -->
19+
20+
## Environment Information
21+
22+
**PowerShell Version**
23+
<!-- Paste the output of $PSVersionTable -->
24+
```powershell
25+
26+
```
27+
28+
**DevSetup Version**
29+
<!-- Paste the output of Get-Module DevSetup or the version you're using -->
30+
```powershell
31+
32+
```
33+
34+
**Operating System**
35+
<!-- e.g., Windows 11, Windows 10, macOS, Linux -->
36+
- OS:
37+
- Version:
38+
- Architecture: [x64/x86/ARM]
39+
40+
**Package Manager Versions** (if applicable)
41+
<!-- Check versions of relevant package managers -->
42+
- [ ] Chocolatey: `choco --version` →
43+
- [ ] Scoop: `scoop --version` →
44+
- [ ] PowerShell Gallery: Available
45+
- [ ] Homebrew: `brew --version` →
46+
47+
## Reproduction Steps
48+
49+
**Steps to Reproduce**
50+
1.
51+
2.
52+
3.
53+
4.
54+
55+
**DevSetup Command Used**
56+
```powershell
57+
# Paste the exact command that caused the issue
58+
```
59+
60+
**Environment File** (if applicable)
61+
<!-- Paste relevant parts of your .devsetup file (remove any sensitive info) -->
62+
```yaml
63+
64+
```
65+
66+
## Error Details
67+
68+
**Error Messages**
69+
<!-- Paste any error messages, warnings, or unexpected output -->
70+
```
71+
Paste error output here
72+
```
73+
74+
**Stack Traces** (if available)
75+
<!-- Include full stack traces if shown -->
76+
```
77+
Paste stack trace here
78+
```
79+
80+
**Log Output** (if available)
81+
<!-- Include relevant log output with -Verbose or Debug flags -->
82+
```
83+
Paste log output here
84+
```
85+
86+
## Provider-Specific Information
87+
88+
**Which provider is affected?** (check all that apply)
89+
- [ ] 🍫 Chocolatey Provider
90+
- [ ] 🥄 Scoop Provider
91+
- [ ] 🍺 Homebrew Provider
92+
- [ ] 💎 PowerShell Module Provider
93+
- [ ] 🏗️ Core Dependencies (Git, Nuget)
94+
- [ ] 📋 3rd Party (Visual Studio, VS Code)
95+
- [ ] 📦 Core Commands
96+
- [ ] 🔧 Utilities/Helper functions
97+
98+
**Specific Package/Component** (if applicable)
99+
<!-- Name of specific package or component causing issues -->
100+
101+
## Additional Context
102+
103+
**Screenshots**
104+
<!-- If applicable, add screenshots to help explain the problem -->
105+
106+
**Configuration Details**
107+
<!-- Any special configuration, network setup, or corporate environment details -->
108+
109+
**Workarounds Attempted**
110+
<!-- What have you tried to fix or work around this issue? -->
111+
- [ ] Restarted PowerShell session
112+
- [ ] Ran as Administrator
113+
- [ ] Used `-DryRUn` to test
114+
- [ ] Checked package manager directly
115+
- [ ] Cleared caches
116+
- [ ] Other:
117+
118+
**Related Issues**
119+
<!-- Link any related issues or discussions -->
120+
121+
## Impact Assessment
122+
123+
**Frequency**
124+
- [ ] Happens every time
125+
- [ ] Happens sometimes
126+
- [ ] Happened once
127+
- [ ] Only in specific conditions
128+
129+
**Severity**
130+
- [ ] 🔥 Critical - Blocks all functionality
131+
- [ ] 🚨 High - Blocks major functionality
132+
- [ ] ⚠️ Medium - Impacts some functionality
133+
- [ ] 📝 Low - Minor issue or cosmetic
134+
135+
**Workaround Available**
136+
- [ ] Yes - I can work around this issue
137+
- [ ] No - This completely blocks my progress
138+
139+
---
140+
141+
**Checklist before submitting:**
142+
- [ ] ✅ I have searched existing issues for duplicates
143+
- [ ] ✅ I have provided all requested environment information
144+
- [ ] ✅ I have included clear reproduction steps
145+
- [ ] ✅ I have removed or obfuscated any sensitive information
146+
- [ ] ✅ I have tested with the latest version of DevSetup

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussion Forum
4+
url: https://github.com/pwshdevs/devsetup/discussions
5+
about: Ask questions, share ideas, and discuss DevSetup with the community
6+
- name: 📖 Documentation
7+
url: https://www.pwshdevs.com/docs/devsetup
8+
about: Read the official documentation and getting started guide
9+
- name: 🔍 Search Issues
10+
url: https://github.com/pwshdevs/devsetup/issues?q=is%3Aissue
11+
about: Search existing issues before creating a new one

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
---
2+
name: 📚 Documentation
3+
about: Request improvements or report issues with documentation
4+
title: '[DOCS] '
5+
labels: ['documentation', 'needs-review']
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
11+
**Type of Documentation Issue** (check one)
12+
- [ ] 📝 Missing documentation
13+
- [ ] 🐛 Incorrect information
14+
- [ ] 🔄 Outdated information
15+
- [ ] 😕 Unclear explanation
16+
- [ ] 💡 Enhancement suggestion
17+
- [ ] 🔗 Broken links
18+
- [ ] 📖 Example needed
19+
- [ ] 🎯 Better organization needed
20+
21+
**Affected Documentation** (check all that apply)
22+
- [ ] 📘 README.md
23+
- [ ] 📋 CONTRIBUTING.md
24+
- [ ] 🔒 SECURITY.md
25+
- [ ] 📄 Function help (Get-Help)
26+
- [ ] 📁 Individual function docs (docs/*.md)
27+
- [ ] 🚀 Installation guide
28+
- [ ] 🎓 Usage examples
29+
- [ ] 🏗️ Architecture/design docs
30+
- [ ] 🔧 Troubleshooting guide
31+
- [ ] Other: ___________
32+
33+
**Specific Location**
34+
<!-- Provide specific file paths, function names, or sections -->
35+
- File/Function:
36+
- Section/Heading:
37+
- Line numbers (if applicable):
38+
39+
## Issue Description
40+
41+
**What's Wrong or Missing?**
42+
<!-- Clear description of the documentation issue -->
43+
44+
**Expected Information**
45+
<!-- What should the documentation say or include? -->
46+
47+
**Current Information**
48+
<!-- What does it currently say (if anything)? -->
49+
50+
## Context and Use Case
51+
52+
**Who Would Benefit?**
53+
- [ ] 👋 New users getting started
54+
- [ ] 💻 Regular users
55+
- [ ] 🔧 Advanced users/power users
56+
- [ ] 🏗️ Contributors/developers
57+
- [ ] 📦 Provider developers
58+
- [ ] 🎓 Tutorial followers
59+
60+
**User Journey Context**
61+
<!-- When would someone need this information? -->
62+
- [ ] During initial setup
63+
- [ ] While learning basic features
64+
- [ ] When troubleshooting issues
65+
- [ ] When contributing code
66+
- [ ] When developing providers
67+
- [ ] When migrating from other tools
68+
69+
**Specific Scenario**
70+
<!-- Describe the specific situation where this documentation is needed -->
71+
72+
## Content Suggestions
73+
74+
**Proposed Content** (if you have suggestions)
75+
<!-- If you know what should be documented, provide draft content -->
76+
77+
**Examples Needed**
78+
<!-- What examples would be helpful? -->
79+
```powershell
80+
# Example commands or code that should be included
81+
82+
```
83+
84+
```yaml
85+
# Example configuration that should be documented
86+
87+
```
88+
89+
**Related Information**
90+
<!-- What other documentation should this link to or reference? -->
91+
92+
## Format and Style Preferences
93+
94+
**Documentation Type Needed**
95+
- [ ] 📝 Conceptual explanation
96+
- [ ] 🔍 Step-by-step tutorial
97+
- [ ] 📖 Reference documentation
98+
- [ ] ⚡ Quick start guide
99+
- [ ] 🎯 How-to guide
100+
- [ ] ❓ FAQ entry
101+
- [ ] 🛠️ Troubleshooting steps
102+
- [ ] 📊 Comparison table
103+
104+
**Level of Detail**
105+
- [ ] 📚 Comprehensive and detailed
106+
- [ ] 📋 Standard level of detail
107+
- [ ] ⚡ Brief and concise
108+
- [ ] 🎯 Just the essentials
109+
110+
**Target Audience Level**
111+
- [ ] 👶 Beginner (new to PowerShell/DevSetup)
112+
- [ ] 📈 Intermediate (familiar with basics)
113+
- [ ] 🎓 Advanced (experienced user)
114+
- [ ] 🔧 Expert (contributor/developer level)
115+
116+
## Research and References
117+
118+
**Research Done**
119+
<!-- What have you already looked at? -->
120+
- [ ] Existing documentation
121+
- [ ] Source code comments
122+
- [ ] Function help content
123+
- [ ] Community discussions
124+
- [ ] Similar tools' documentation
125+
126+
**External References**
127+
<!-- Any external documentation that might be helpful -->
128+
129+
**Similar Examples**
130+
<!-- Examples from other projects or tools that do this well -->
131+
132+
## Impact and Priority
133+
134+
**How Important is This?**
135+
- [ ] 🔥 Critical - Blocking users from using the tool
136+
- [ ] 🚨 High - Causes frequent confusion or support requests
137+
- [ ] ⚠️ Medium - Would improve user experience
138+
- [ ] 📝 Low - Nice to have improvement
139+
140+
**Frequency of Need**
141+
- [ ] Daily - Users hit this regularly
142+
- [ ] Weekly - Common scenario
143+
- [ ] Monthly - Occasional need
144+
- [ ] Rarely - Edge case scenario
145+
146+
**Current Workaround**
147+
<!-- How are users currently figuring this out? -->
148+
- [ ] Asking in discussions/issues
149+
- [ ] Reading source code
150+
- [ ] Trial and error
151+
- [ ] Finding examples elsewhere
152+
- [ ] No workaround available
153+
154+
## Contribution Offer
155+
156+
**How Can You Help?**
157+
- [ ] ✅ I can draft the content
158+
- [ ] ✅ I can provide examples
159+
- [ ] ✅ I can review drafts
160+
- [ ] ✅ I can test instructions
161+
- [ ] ✅ I can provide feedback only
162+
- [ ] ❌ I need help from maintainers
163+
164+
**Content Draft** (if applicable)
165+
<!-- If you're willing to draft content, include it here -->
166+
167+
**Additional Context**
168+
<!-- Any other context that would help improve the documentation -->
169+
170+
---
171+
172+
**Checklist before submitting:**
173+
- [ ] ✅ I have searched existing documentation for this information
174+
- [ ] ✅ I have checked recent issues for similar documentation requests
175+
- [ ] ✅ I have provided specific location information where possible
176+
- [ ] ✅ I have described the user scenario clearly
177+
- [ ] ✅ I have indicated how I can help improve the documentation

0 commit comments

Comments
 (0)