Skip to content

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

docs: add SECURITY.md

itsfatduck48da9b4aa061
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..ddf5a28
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @itsfatduck
\ No newline at end of file
diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
similarity index 100%
rename from CODE_OF_CONDUCT.md
rename to .github/CODE_OF_CONDUCT.md
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..ce23281
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contributing to optimizerDuck
+
+Thanks for your interest in contributing.
+
+For full contribution guidelines, coding standards, and workflow details, please visit:
+https://optimizerduck.vercel.app/docs/contribute/overview
+
+## Quick Overview
+
+- Open an issue before starting large changes
+- Follow existing code style
+- Keep pull requests focused and minimal
+- Ensure the project builds successfully
+
+We appreciate every contribution.
\ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 88650be..8fc5857 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,11 +1,11 @@
-## πŸ“ Description
+## 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 (`fix:` - non-breaking change which fixes an issue)
- [ ] ⚑ New Optimization/Tweak (`feat:` - adds a new system tweak or optimization rule)
@@ -14,7 +14,7 @@ Link any relevant GitHub issues here (e.g., "Fixes #123" or "Closes #456").
- [ ] πŸ“ Documentation update (`docs:`)
- [ ] 🌐 Translation/Localization update (`chore:` or `feat:`)
-## βœ… Checklist
+## 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`).
@@ -26,13 +26,13 @@ Link any relevant GitHub issues here (e.g., "Fixes #123" or "Closes #456").
- [ ] 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)
+## 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
+## Additional Context
<!--
Add any other context about the pull request here. Are there any side effects? Any registry paths that reviewers should manually verify?
-->
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
new file mode 100644
index 0000000..4bec2af
--- /dev/null
+++ b/.github/SECURITY.md
@@ -0,0 +1,13 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you believe you have found a security vulnerability in optimizerDuck, please do NOT open a public GitHub issue.
+
+Instead, report it privately through our official security page:
+
+πŸ‘‰ https://optimizerduck.vercel.app/docs/contribute/security
+
+That page contains detailed instructions on responsible disclosure, response timelines, and supported versions.
+
+We appreciate responsible disclosure and will respond as quickly as possible.
\ No newline at end of file
diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
new file mode 100644
index 0000000..02592ed
--- /dev/null
+++ b/.github/SUPPORT.md
@@ -0,0 +1,29 @@
+# Support
+
+If you need help, please use one of the following channels:
+
+## Quick Questions & Discussions
+Join our Discord:
+https://discord.gg/tDUBDCYw9Q
+
+## Bug Reports
+Open a GitHub issue:
+https://github.com/itsfatduck/optimizerDuck/issues
+
+## Feature Requests
+Create a discussion or issue with detailed context:
+https://github.com/itsfatduck/optimizerDuck/issues
+
+## Translations
+Create a discussion or issue with detailed context:
+https://github.com/itsfatduck/optimizerDuck/issues
+
+## Donations
+
+Even small contributions make a big difference.
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/itsfatduck)
+
+Please do not use issues for general support questions.
+Learn more about how to support optimizerDuck at:
+https://optimizerduck.vercel.app/docs/contribute/overview
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index a62d2e3..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,85 +0,0 @@
-# Contributing to optimizerDuck
-
-First of all, thank you for taking the time to contribute! πŸŽ‰
-We want to make contributing to `optimizerDuck` as easy, transparent, and welcoming as possible.
-
-## πŸ’¬ Where to Get Help
-If you have questions, need help, or want to discuss a feature, feel free to reach out to the author directly:
-- **Discord**: contact via project server (link in README)
-- **Email**: [email protected]
-- **GitHub Issues**: Open a discussion or an issue.
-
-## πŸ› οΈ Setting Up the Project
-
-1. **Clone the repository:**
- ```bash
- git clone https://github.com/itsfatduck/optimizerDuck.git
- cd optimizerDuck
- ```
-2. **Build the project:**
- Execute the `build.bat` script in the root directory or run:
- ```bash
- dotnet build optimizerDuck.slnx
- ```
-
-## πŸ—οΈ Project Structure & Module Organization
-
-To help you get started quickly, here is how the code is organized:
-
-- **`optimizerDuck/`**: The core C# Windows application source.
- - `UI/`: Contains XAML views, pages, and components.
- - `Services/`: Houses business logic and system operations (e.g., `DiskCleanupService.cs`, `OptimizationService.cs`).
- - `Common/`: Shared utilities, helpers, and data converters.
- - `Resources/`: Application assets and multi-language `.resx` translation files.
-- **`optimizerDuck.Test/`**: The xUnit test suite for validating application logic.
-
-## πŸ“ Coding Style & Naming Conventions
-
-This project targets modern .NET (C#) and uses XAML for the frontend presentation.
-
-- **Classes & Methods**: Use `PascalCase` (e.g., `OptimizationService`, `GetSettings()`).
-- **Variables & Parameters**: Use `camelCase` (e.g., `availableSpace`, `configData`).
-- **Linting & Formatting**: Follow standard C# conventions. The project's `.editorconfig` silently suppresses `CA1416` (Platform compatibility) warnings.
-
-## 🌍 Localization Guidelines
-
-optimizerDuck supports multiple languages. If you are adding new features or modifying the UI, please observe the following rules:
-
-1. **No Hardcoded Strings**: Never hardcode user-facing text directly in XAML or C# code.
-2. **Resource Files**: All application texts are securely managed in `.resx` files inside `optimizerDuck/Resources/Languages/`.
- - `Translations.resx`: The primary English file. **Always** add your new keys and texts here first.
- - `Translations.[lang].resx`: Files for other supported languages (e.g., `vi-VN`, `zh-Hans`, `ru-RU`).
-3. **Adding New Strings**:
- - Please add any new resource keys to **all** existing `.resx` files.
- - If you do not speak a specific language, you can use machine translation (like Google Translate or AI) as a placeholder. The community will help correct it later!
-4. **Using Translations in XAML**:
- Always use the custom extension to bind text:
- ```xaml
- Text="{ext:Loc Your.Translation.Key}"
- ```
-## πŸ§ͺ Testing Guidelines
-
-We utilize **xUnit** as our testing framework and `coverlet` for test coverage.
-
-- **Test Placement**: Align test project paths with the main project layout (e.g., tests for `Services/` go into `optimizerDuck.Test/Services/`).
-- **Naming Convention**: Suffix your test classes with `Tests` (e.g., `DiskCleanupServiceTests.cs`). Describe the behavior being tested clearly formatted in your test method names.
-- **Running Tests**: You can execute the test suite via the .NET CLI:
- ```bash
- dotnet test optimizerDuck.Test/optimizerDuck.Test.csproj
- ```
-
-## πŸš€ Commit & Pull Request Guidelines
-
-We follow the **Conventional Commits** format for our Git workflow. Please structure your commit messages using these prefixes:
-
-- `feat:` for new capabilities (e.g., `feat: add disk cleanup page and its features`).
-- `fix:` for bug resolutions (e.g., `fix: use proper color`).
-- `refactor:` for restructurings or enhancements (e.g., `refactor: move converters to common`).
-
-**When submitting a Pull Request:**
-1. Prepend the PR title with the appropriate conventional commit type.
-2. Ensure all recent changes compile successfully and all tests pass.
-3. Provide a brief description of the applied modifications. Link any relevant GitHub issues.
-4. Include a visual screenshot or GIF if your pull request modifies or creates UI elements.
-
-Happy optimizing! πŸ¦†
diff --git a/SUPPORT.md b/SUPPORT.md
deleted file mode 100644
index 733f377..0000000
--- a/SUPPORT.md
+++ /dev/null
@@ -1,57 +0,0 @@
-<div align="center">
- <img src="./.github/assets/optimizerDuck.png" alt="optimizerDuck Banner" title="optimizerDuck" width="600"/>
-</div>
-
-# πŸ’– Support optimizerDuck
-
-Hi πŸ‘‹
-I'm **fatDuck** ([@itsfatduck](https://github.com/itsfatduck)), the creator of **optimizerDuck**.
-
-optimizerDuck is a free and open-source project built with the goal of improving Windows performance, privacy, and simplicity without ads, tracking, or paywalls.
-
-If this project helped improve your PC experience, you can support its development through a donation.
-
-Your support helps with:
-
-* πŸš€ Continued development & new features
-* πŸ›  Maintenance and updates
-* 🌍 Expanding language support
-* πŸ’¬ Community support & infrastructure
-
-<img src="./.github/assets/capoo_like.webp" alt="Capoo Like" title="Capoo Like" height="80"/>
-
----
-
-## β˜• Quick & Easy Support
-
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/itsfatduck)
-
-Even small contributions make a big difference.
-
----
-
-## ⭐ Other Ways to Support
-
-Not able to donate? No problem ❀️
-
-You can still support optimizerDuck by:
-
-* ⭐ Starring the repository
-* πŸ“’ Sharing it with others
-* 🐞 Reporting bugs
-* πŸ’‘ Suggesting features
-* 🌍 Helping translate
-* πŸ’¬ Joining the Discord server
-
-[![Discord server](https://discordapp.com/api/guilds/1091675679994675240/widget.png?style=banner3)](https://discord.gg/tDUBDCYw9Q)
-
-Every contribution, financial or not, helps the project grow.
-
----
-
-## πŸ¦† Thank You
-
-optimizerDuck exists because of its community.
-
-Whether you donate, contribute, or simply use the tool,
-**thank you for supporting optimizerDuck.**
\ No newline at end of file