Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 146 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
---
name: 🐛 Bug Report
about: Create a report to help us improve DevSetup
title: '[BUG] '
labels: ['bug', 'needs-triage']
assignees: ''
---

## Bug Description

**Brief Summary**
<!-- A clear and concise description of what the bug is -->

**Expected Behavior**
<!-- What you expected to happen -->

**Actual Behavior**
<!-- What actually happened -->

## Environment Information

**PowerShell Version**
<!-- Paste the output of $PSVersionTable -->
```powershell

```

**DevSetup Version**
<!-- Paste the output of Get-Module DevSetup or the version you're using -->
```powershell

```

**Operating System**
<!-- e.g., Windows 11, Windows 10, macOS, Linux -->
- OS:
- Version:
- Architecture: [x64/x86/ARM]

**Package Manager Versions** (if applicable)
<!-- Check versions of relevant package managers -->
- [ ] Chocolatey: `choco --version` →
- [ ] Scoop: `scoop --version` →
- [ ] PowerShell Gallery: Available
- [ ] Homebrew: `brew --version` →

## Reproduction Steps

**Steps to Reproduce**
1.
2.
3.
4.

**DevSetup Command Used**
```powershell
# Paste the exact command that caused the issue
```

**Environment File** (if applicable)
<!-- Paste relevant parts of your .devsetup file (remove any sensitive info) -->
```yaml

```

## Error Details

**Error Messages**
<!-- Paste any error messages, warnings, or unexpected output -->
```
Paste error output here
```

**Stack Traces** (if available)
<!-- Include full stack traces if shown -->
```
Paste stack trace here
```

**Log Output** (if available)
<!-- Include relevant log output with -Verbose or Debug flags -->
```
Paste log output here
```

## Provider-Specific Information

**Which provider is affected?** (check all that apply)
- [ ] 🍫 Chocolatey Provider
- [ ] 🥄 Scoop Provider
- [ ] 🍺 Homebrew Provider
- [ ] 💎 PowerShell Module Provider
- [ ] 🏗️ Core Dependencies (Git, Nuget)
- [ ] 📋 3rd Party (Visual Studio, VS Code)
- [ ] 📦 Core Commands
- [ ] 🔧 Utilities/Helper functions

**Specific Package/Component** (if applicable)
<!-- Name of specific package or component causing issues -->

## Additional Context

**Screenshots**
<!-- If applicable, add screenshots to help explain the problem -->

**Configuration Details**
<!-- Any special configuration, network setup, or corporate environment details -->

**Workarounds Attempted**
<!-- What have you tried to fix or work around this issue? -->
- [ ] Restarted PowerShell session
- [ ] Ran as Administrator
- [ ] Used `-DryRUn` to test
- [ ] Checked package manager directly
- [ ] Cleared caches
- [ ] Other:

**Related Issues**
<!-- Link any related issues or discussions -->

## Impact Assessment

**Frequency**
- [ ] Happens every time
- [ ] Happens sometimes
- [ ] Happened once
- [ ] Only in specific conditions

**Severity**
- [ ] 🔥 Critical - Blocks all functionality
- [ ] 🚨 High - Blocks major functionality
- [ ] ⚠️ Medium - Impacts some functionality
- [ ] 📝 Low - Minor issue or cosmetic

**Workaround Available**
- [ ] Yes - I can work around this issue
- [ ] No - This completely blocks my progress

---

**Checklist before submitting:**
- [ ] ✅ I have searched existing issues for duplicates
- [ ] ✅ I have provided all requested environment information
- [ ] ✅ I have included clear reproduction steps
- [ ] ✅ I have removed or obfuscated any sensitive information
- [ ] ✅ I have tested with the latest version of DevSetup
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Discussion Forum
url: https://github.com/pwshdevs/devsetup/discussions
about: Ask questions, share ideas, and discuss DevSetup with the community
- name: 📖 Documentation
url: https://www.pwshdevs.com/docs/devsetup
about: Read the official documentation and getting started guide
- name: 🔍 Search Issues
url: https://github.com/pwshdevs/devsetup/issues?q=is%3Aissue
about: Search existing issues before creating a new one
177 changes: 177 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
---
name: 📚 Documentation
about: Request improvements or report issues with documentation
title: '[DOCS] '
labels: ['documentation', 'needs-review']
assignees: ''
---

## Documentation Issue

**Type of Documentation Issue** (check one)
- [ ] 📝 Missing documentation
- [ ] 🐛 Incorrect information
- [ ] 🔄 Outdated information
- [ ] 😕 Unclear explanation
- [ ] 💡 Enhancement suggestion
- [ ] 🔗 Broken links
- [ ] 📖 Example needed
- [ ] 🎯 Better organization needed

**Affected Documentation** (check all that apply)
- [ ] 📘 README.md
- [ ] 📋 CONTRIBUTING.md
- [ ] 🔒 SECURITY.md
- [ ] 📄 Function help (Get-Help)
- [ ] 📁 Individual function docs (docs/*.md)
- [ ] 🚀 Installation guide
- [ ] 🎓 Usage examples
- [ ] 🏗️ Architecture/design docs
- [ ] 🔧 Troubleshooting guide
- [ ] Other: ___________

**Specific Location**
<!-- Provide specific file paths, function names, or sections -->
- File/Function:
- Section/Heading:
- Line numbers (if applicable):

## Issue Description

**What's Wrong or Missing?**
<!-- Clear description of the documentation issue -->

**Expected Information**
<!-- What should the documentation say or include? -->

**Current Information**
<!-- What does it currently say (if anything)? -->

## Context and Use Case

**Who Would Benefit?**
- [ ] 👋 New users getting started
- [ ] 💻 Regular users
- [ ] 🔧 Advanced users/power users
- [ ] 🏗️ Contributors/developers
- [ ] 📦 Provider developers
- [ ] 🎓 Tutorial followers

**User Journey Context**
<!-- When would someone need this information? -->
- [ ] During initial setup
- [ ] While learning basic features
- [ ] When troubleshooting issues
- [ ] When contributing code
- [ ] When developing providers
- [ ] When migrating from other tools

**Specific Scenario**
<!-- Describe the specific situation where this documentation is needed -->

## Content Suggestions

**Proposed Content** (if you have suggestions)
<!-- If you know what should be documented, provide draft content -->

**Examples Needed**
<!-- What examples would be helpful? -->
```powershell
# Example commands or code that should be included

```

```yaml
# Example configuration that should be documented

```

**Related Information**
<!-- What other documentation should this link to or reference? -->

## Format and Style Preferences

**Documentation Type Needed**
- [ ] 📝 Conceptual explanation
- [ ] 🔍 Step-by-step tutorial
- [ ] 📖 Reference documentation
- [ ] ⚡ Quick start guide
- [ ] 🎯 How-to guide
- [ ] ❓ FAQ entry
- [ ] 🛠️ Troubleshooting steps
- [ ] 📊 Comparison table

**Level of Detail**
- [ ] 📚 Comprehensive and detailed
- [ ] 📋 Standard level of detail
- [ ] ⚡ Brief and concise
- [ ] 🎯 Just the essentials

**Target Audience Level**
- [ ] 👶 Beginner (new to PowerShell/DevSetup)
- [ ] 📈 Intermediate (familiar with basics)
- [ ] 🎓 Advanced (experienced user)
- [ ] 🔧 Expert (contributor/developer level)

## Research and References

**Research Done**
<!-- What have you already looked at? -->
- [ ] Existing documentation
- [ ] Source code comments
- [ ] Function help content
- [ ] Community discussions
- [ ] Similar tools' documentation

**External References**
<!-- Any external documentation that might be helpful -->

**Similar Examples**
<!-- Examples from other projects or tools that do this well -->

## Impact and Priority

**How Important is This?**
- [ ] 🔥 Critical - Blocking users from using the tool
- [ ] 🚨 High - Causes frequent confusion or support requests
- [ ] ⚠️ Medium - Would improve user experience
- [ ] 📝 Low - Nice to have improvement

**Frequency of Need**
- [ ] Daily - Users hit this regularly
- [ ] Weekly - Common scenario
- [ ] Monthly - Occasional need
- [ ] Rarely - Edge case scenario

**Current Workaround**
<!-- How are users currently figuring this out? -->
- [ ] Asking in discussions/issues
- [ ] Reading source code
- [ ] Trial and error
- [ ] Finding examples elsewhere
- [ ] No workaround available

## Contribution Offer

**How Can You Help?**
- [ ] ✅ I can draft the content
- [ ] ✅ I can provide examples
- [ ] ✅ I can review drafts
- [ ] ✅ I can test instructions
- [ ] ✅ I can provide feedback only
- [ ] ❌ I need help from maintainers

**Content Draft** (if applicable)
<!-- If you're willing to draft content, include it here -->

**Additional Context**
<!-- Any other context that would help improve the documentation -->

---

**Checklist before submitting:**
- [ ] ✅ I have searched existing documentation for this information
- [ ] ✅ I have checked recent issues for similar documentation requests
- [ ] ✅ I have provided specific location information where possible
- [ ] ✅ I have described the user scenario clearly
- [ ] ✅ I have indicated how I can help improve the documentation
Loading
Loading