Free, open-source Windows optimization tool for performance, privacy, and simplicity.
C# csharpdebloatdotnetgamingopen-sourceoptimizationoptimizeroptimizerduckperformanceprivacytweakertweakswindowswinui
docs: rewrite templates
fatDuck3d91dbbc0375
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.mdindex 545c1e5..cf3ec0d 100644--- a/.github/ISSUE_TEMPLATE/bug_report.md+++ b/.github/ISSUE_TEMPLATE/bug_report.md@@ -1,35 +1,30 @@----name: "π Bug Report"-about: Create a report to help me improve optimizerDuck-title: 'fix: [Brief description of the bug]'+name: "\U0001F41B Bug Report"+about: Report a crash, error, or unexpected behavior in optimizerDuck+title: ''labels: bugassignees: ''---**Describe the bug**-A clear and concise description of what the bug is.+What happened? What did you expect to happen instead?-**To Reproduce**-Steps to reproduce the behavior:+**Steps to reproduce**1. Go to '...'-2. Navigate to '....'-3. Click on '....'+2. Click on '...'+3. Scroll to '...'4. See error-**Expected behavior**-A clear and concise description of what you expected to happen vs what actually happened.+**Screenshots**+If applicable, add screenshots or a screen recording.-**Screenshots or Video**-If applicable, add screenshots or a screen recording to help explain your problem. Visuals are highly appreciated!+**System info**+- Windows version: (e.g. Windows 11 Pro 24H2, build 26100.1742)+- optimizerDuck version: (e.g. v2.17.4 β see title bar or About page)+- Ran as administrator? Yes / No-**Desktop Environment:**- - 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/`+**Logs**+Attach the log file from `%localappdata%\optimizerDuck\optimizerDuck.log`. This is especially important for crashes or optimization failures.**Additional context**-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").+Anything else? Recent Windows updates? Antivirus? Other tools running?diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.mdindex c96f095..7eeac15 100644--- a/.github/ISSUE_TEMPLATE/feature_request.md+++ b/.github/ISSUE_TEMPLATE/feature_request.md@@ -1,25 +1,24 @@----name: "β¨ Feature Request"-about: Suggest a general feature, UI change, or functional addition to optimizerDuck-title: 'feat: [Brief description of the feature]'+name: "\U0001F4A1 App Feature Request"+about: Suggest a new app feature, UI change, page, or tool (not a Windows tweak)+title: ''labels: enhancementassignees: ''----> [!NOTE]-> If you are suggesting a specific Windows tweak or optimization script, please use the **"Optimization Tweak Request"** template instead!+> For Windows-specific tweaks or optimizations (registry changes, service tweaks, etc.), 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 [...]+**Problem**+What's missing or frustrating? What can't you do right now?-**Describe the solution you'd like**-A clear and concise description of what you want to happen. How should it look? How should it work?+**Solution**+How should it work? What should the user see or interact with?-**Describe alternatives you've considered**-A clear and concise description of any alternative solutions or features you've considered.+**Alternatives considered**+Did you try any workarounds? Any other apps that do this well?-**Mockups or Design Inspiration**-If applicable, attach UI mockups, sketches, or screenshots from other apps that have the design/feature you want.+**Mockups / references**+Screenshots, sketches, or links to apps with a similar feature.**Additional context**-Add any other context about the feature request here.+Anything else that helps understand the request.diff --git a/.github/ISSUE_TEMPLATE/optimization_request.md b/.github/ISSUE_TEMPLATE/optimization_request.mdindex 28103c0..5cd2e61 100644--- a/.github/ISSUE_TEMPLATE/optimization_request.md+++ b/.github/ISSUE_TEMPLATE/optimization_request.md@@ -1,43 +1,40 @@----name: "β‘ Optimization Tweak Request"-about: Request a new optimization or tweak to be added to optimizerDuck-title: 'feat: add [optimization name]'-labels: 'enhancement, optimization'+name: "\u26A1 Optimization Tweak Request"+about: Suggest a Windows tweak, registry change, or optimization to add+title: ''+labels: enhancement, optimizationassignees: ''----**Optimization Name**-A brief, clear name for the optimization (e.g., `Disable Telemetry`, `Enable Game Mode`).+**Tweak name**+Short and clear (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`).+**Description**+What does this tweak do? One or two sentences.-**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:+**Technical details**+Provide the registry path, PowerShell command, CMD command, or service name needed.+```text+Path:+Value name:+Value data:+Type: (DWORD / QWORD / String / Multi-String)+---+Or script/command:```-**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).+**Category**+Which category should this go in? (Performance / Security & Privacy / GPU / Power Management / Bloatware & Services / User Experience)-**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)+**Risk level**+- [ ] Safe β easily reversible, no side effects+- [ ] Moderate β may affect some apps or features+- [ ] Risky β core system change, could cause instability**Tags**-List the relevant `OptimizationTags` (e.g., Privacy, Performance, System, UI, Network, Storage, etc.)+Any of these apply? Privacy / Performance / System / Network / Audio / Visual / Display / Power / Latency / RAM / Disk+GPU vendor? Nvidia / AMD / Intel-**References & Documentation**-Add any links to Microsoft documentation, GitHub issues, or technical articles that validate this tweak.+**References**+Links to Microsoft docs, forum posts, or articles that back this up.diff --git a/.github/ISSUE_TEMPLATE/translation_request.md b/.github/ISSUE_TEMPLATE/translation_request.mddeleted file mode 100644index c0d13fb..0000000--- a/.github/ISSUE_TEMPLATE/translation_request.md+++ /dev/null@@ -1,32 +0,0 @@-----name: "π Translation Request"-about: Request a new language translation or report translation errors in optimizerDuck-title: 'feat(i18n): add [Language] translation (or update [Language] translation)'-labels: 'translation, enhancement'-assignees: ''------**Language**-Which language are you requesting or reporting an issue for? (e.g., `Vietnamese (vi-VN)`, `Spanish (es-ES)`).--**Request Type**-- [ ] β New Language Translation-- [ ] π Fixing an Existing Translation--**Requested Fixes**-If reporting incorrect translations, please list them below. You can use the table format or just list them.--| Translation Key (if known) | Current Translation | Correct Translation |-| :--- | :--- | :--- |-| `Example.Key` | `Old text` | `New better text` |--> [!TIP]-> Add more rows as needed. If you don't know the key, please describe the location (e.g., "Privacy Page > Bottom Button").--**Are you planning to contribute the fix yourself?**-Selecting "Yes" means you intend to edit the `.resx` files and submit a Pull Request. We highly encourage this!-- [ ] **Yes**, I will submit a Pull Request with the fixes.-- [ ] **No**, I am just reporting the issue for the maintainers to handle.--**Additional context**-Add any other context or screenshots showing the translation issue here.diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.mdindex 4c0f31e..c29afd1 100644--- a/.github/PULL_REQUEST_TEMPLATE.md+++ b/.github/PULL_REQUEST_TEMPLATE.md@@ -1,31 +1,23 @@## 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").--->+What does this PR do? Why is it needed?-## Type of Change+Closes #-<!-- Please check the options that apply -->+## Type of change-- [ ] π Bug fix (`fix:` - non-breaking change which fixes an issue)-- [ ] β‘ New Optimization/Feature (`feat:` - adds a new optimization or feature)-- [ ] β¨ 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 (`i18n:` or `chore:`)+- [ ] `feat:` β New optimization, customize setting, or app feature+- [ ] `fix:` β Bug fix+- [ ] `refactor:` β Code restructuring without behavior change+- [ ] `docs:` β Documentation+- [ ] `test:` β Adding or fixing tests+- [ ] `i18n:` β Translation / localization update+- [ ] `chore:` β Build, deps, CI, tooling-## Screenshots or Video (if applicable)+## Screenshots (if UI changes)-<!---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.--->+<!-- Drag & drop images here -->-## Additional Context+## Notes-<!---Add any other context about the pull request here. Are there any side effects? Any registry paths that reviewers should manually verify?--->+Any caveats, side effects, or registry paths reviewers should verify manually?diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 29b0713..d13e1fc 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -273,7 +273,8 @@ Optimizer.{CategoryName}.{OptimizationKey}.Error.{...}Where `CategoryName` is the category class name (e.g., `Performance`) and `OptimizationKey` is the nested class name.-> Missing keys return the key string itself β add them in `Translations.resx`!+> [!IMPORTANT]+> **Translations required**. If you skip adding these keys, the app will display raw key strings like `"Optimizer.Performance.MyNewTweak.Name"` instead of readable text. Always add entries in `Translations.resx` (English). You may also add translations for your own language in `Translations.{locale}.resx` β see [Translations section](#translations-localization).---@@ -380,6 +381,9 @@ Customize.{CategoryName}.{SettingKey}.Recommendation.Reason (if RecommendationCustomize.{CategoryName}.Section.{SectionName} (for section headers)```+> [!IMPORTANT]+> **Translations required**. Same rule applies β `BaseCustomizeSetting` reads `Name` and `Description` from these keys. Add them to `Translations.resx` (English) at minimum. Your own locale is welcome too β just add the keys to `Translations.{locale}.resx`.+---### Building New App Functionality