Skip to content

Free, open-source Windows optimization tool for performance, privacy, and simplicity.

feat: Add a dedicated optimization request template and refine existing issue and pull request templates.

fatDucke2e5fc3c0d64
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 8e98109..0000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,11 +0,0 @@
-<!--
-Please consider using one of the specific issue templates available in this repository:
-- Bug Report: For reporting bugs and glitches
-- Feature Request: For suggesting new features and enhancements
--->
-
-**Describe the issue:**
-[Provide a detailed description of the issue or question.]
-
-**Additional Context:**
-[Any other context relevant to the issue.]
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 5434e5b..545c1e5 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,6 +1,6 @@
---
-name: πŸ› Bug Report
-about: Create a report to help us improve optimizerDuck
+name: "πŸ› Bug Report"
+about: Create a report to help me improve optimizerDuck
title: 'fix: [Brief description of the bug]'
labels: bug
assignees: ''
@@ -12,19 +12,24 @@ A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
+2. Navigate to '....'
+3. Click on '....'
4. See error
**Expected behavior**
-A clear and concise description of what you expected to happen.
+A clear and concise description of what you expected to happen vs what actually happened.
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots or Video**
+If applicable, add screenshots or a screen recording to help explain your problem. Visuals are highly appreciated!
**Desktop Environment:**
- - OS: [e.g. Windows 10, Windows 11]
- - Version/Build [e.g. 22H2]
+ - OS Version & Build number: [e.g. Windows 11 Pro 23H2 OS Build 22631.3296]
+ - app Version: [e.g. optimizerDuck v1.0.0]
+ - .NET Runtime Version (if applicable): [e.g. 10.0.103]
+
+**App Logs (Important)**
+Please attach the optimizerDuck log files if this is a crash or optimization failure.
+Logs can usually be found at: `%localappdata%/optimizerDuck/`
**Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here (e.g., "I just ran a Windows Update" or "I was running an antivirus at the time").
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index bb0738f..048ef73 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,19 +1,24 @@
---
-name: ✨ Feature Request
-about: Suggest an idea for optimizerDuck
+name: "✨ Feature Request"
+about: Suggest a general feature, UI change, or functional addition to optimizerDuck
title: 'feat: [Brief description of the feature]'
labels: enhancement
assignees: ''
---
+> **Note:** If you are suggesting a specific Windows tweak or optimization script, please use the **"Optimization Tweak Request"** template instead!
+
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+A clear and concise description of what you want to happen. How should it look? How should it work?
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
+**Mockups or Design Inspiration**
+If applicable, attach UI mockups, sketches, or screenshots from other apps that have the design/feature you want.
+
**Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/optimization_request.md b/.github/ISSUE_TEMPLATE/optimization_request.md
new file mode 100644
index 0000000..28103c0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/optimization_request.md
@@ -0,0 +1,43 @@
+---
+name: "⚑ Optimization Tweak Request"
+about: Request a new optimization or tweak to be added to optimizerDuck
+title: 'feat: add [optimization name]'
+labels: 'enhancement, optimization'
+assignees: ''
+---
+
+**Optimization Name**
+A brief, clear name for the optimization (e.g., `Disable Telemetry`, `Enable Game Mode`).
+
+**Short Description**
+A one-sentence description of the optimization (e.g., `Disables Microsoft telemetry services to improve privacy`).
+
+**Technical Details (Implementation Code)**
+Provide the exact Registry Key, PowerShell command, CMD script, or C# code required to apply this optimization.
+```text
+Registry Key:
+Value Name:
+Value Data:
+Type: (DWORD/QWORD/String)
+--- or ---
+Script/Code:
+
+```
+
+**Impact and Effect**
+Explain what this optimization actually does under the hood. Why would a user want to apply it? What is improved?
+
+**Category & Location**
+Where should this optimization be located in the app? (e.g., Privacy, System, Gaming, Network, Context Menu).
+
+**Risk Level**
+Please suggest a risk level for this optimization based on our `OptimizationRisk` enum:
+- [ ] Safe (Easily reversible, zero system impact)
+- [ ] Moderate (May disable certain obscure features or affect some apps)
+- [ ] Risky (Core system/registry change, could cause instability if used incorrectly)
+
+**Tags**
+List the relevant `OptimizationTags` (e.g., Privacy, Performance, System, UI, Network, Storage, etc.)
+
+**References & Documentation**
+Add any links to Microsoft documentation, GitHub issues, or technical articles that validate this tweak.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index ef1ab8a..88650be 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,20 +1,38 @@
-## Description
-<!-- Provide a brief description of the changes applied. Link any relevant GitHub issues here (e.g., "Fixes #123"). -->
+## πŸ“ Description
+<!--
+Provide a detailed description of the changes applied.
+If this PR is adding a new Optimization, briefly explain how it works and what it modifies in the Windows OS.
+Link any relevant GitHub issues here (e.g., "Fixes #123" or "Closes #456").
+-->
-## Type of Change
+## πŸ”„ Type of Change
<!-- Please check the options that apply -->
-- [ ] πŸ› Bug fix (non-breaking change which fixes an issue - `fix:`)
-- [ ] ✨ New feature (non-breaking change which adds functionality - `feat:`)
-- [ ] πŸ› οΈ Refactoring (changes that neither fix a bug nor add a feature - `refactor:`)
-- [ ] πŸ“ Documentation update
-- [ ] 🌐 Translation update
+- [ ] πŸ› Bug fix (`fix:` - non-breaking change which fixes an issue)
+- [ ] ⚑ New Optimization/Tweak (`feat:` - adds a new system tweak or optimization rule)
+- [ ] ✨ New App Feature (`feat:` - adds UI, services, or core app functionality)
+- [ ] πŸ› οΈ Refactoring (`refactor:` - code restructure that neither fixes a bug nor adds a feature)
+- [ ] πŸ“ Documentation update (`docs:`)
+- [ ] 🌐 Translation/Localization update (`chore:` or `feat:`)
-## Checklist
-<!-- Please ensure all of the following are checked before submitting the PR -->
-- [ ] My commit messages follow the **Conventional Commits** format (e.g., `feat: added disk cleanup`).
-- [ ] I have tested my changes locally, and all tests pass (run `dotnet test`).
-- [ ] My code follows the project's coding style and naming conventions.
-- [ ] I have added/updated `.resx` files for any new user-facing strings (no hardcoded UI text).
+## βœ… Checklist
+<!-- Please ensure all of the following points are checked before submitting the PR -->
+- [ ] **Commit Messages:** My PR title and commit messages follow the **Conventional Commits** format (e.g., `feat: add game mode optimization`, `fix: correct layout glitch`).
+- [ ] **Compilation & Tests:** I have built the application (`dotnet build optimizerDuck.slnx`) and all tests pass (`dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj`).
+- [ ] **Code Style:** My C# code follows the project's naming conventions (`PascalCase` for classes/methods, `camelCase` for vars) and styling rules.
+- [ ] **Localization (If adding UI text):** I did NOT hardcode UI text. I have updated the `.resx` files located in the `optimizerDuck/Resources/Languages/` directory.
-## Screenshots / GIFs (if applicable)
-<!-- Include a visual screenshot or GIF if your pull request modifies or creates UI elements. -->
+### For New Optimizations (Skip if irrelevant)
+- [ ] I inherited from `BaseOptimization` (or implemented `IOptimization`).
+- [ ] I included the `[Optimization]` attribute with a valid `Guid` formatted `Id`, a correct `OptimizationRisk`, and appropriate `Tags`.
+- [ ] I mapped the string keys properly so the Name and Description can be translated.
+
+## πŸ“Έ Screenshots or Video (if applicable)
+<!--
+If your pull request modifies or creates UI elements, please include a visual screenshot or GIF here.
+If it's purely a backend or script logic change, you can delete this section.
+-->
+
+## ⚠️ Additional Context
+<!--
+Add any other context about the pull request here. Are there any side effects? Any registry paths that reviewers should manually verify?
+-->