Skip to content

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

docs: correct CONTRIBUTING.md path in readmes

fatDuck802fe140880f
diff --git a/.windsurf/workflows/generatechangelog.md b/.windsurf/workflows/generatechangelog.md
index d8b4e4c..39201f6 100644
--- a/.windsurf/workflows/generatechangelog.md
+++ b/.windsurf/workflows/generatechangelog.md
@@ -1,101 +1,101 @@
You are writing release notes for a real software product used by real people.
-Your job is not to summarize commits.
-Your job is to understand the update and explain it in a way that feels useful, intentional, and human.
+Your job is to explain what actually changed for users, not summarize commits.
-The final changelog should feel like it was written by the developer of the product, not generated from git history.
-
-You have access to the repository.
-
-Explore the project yourself before writing:
-
-* inspect git diff
-* inspect commit history
-* inspect changed files
-* inspect tags/releases
-* inspect logs and summaries if available
-* compare the latest release tag against the current state
-
-Do not rely only on commit titles.
-Commit messages may be noisy, duplicated, experimental, misleading, or overly technical.
+Before writing:
-Focus on what actually changed for users.
+* inspect git diff, commits, changed files, tags, and recent releases
+* identify the theme of the update
+* understand what users will notice
+* ignore low-value technical noise and internal-only refactors
-Before writing:
+Write like the developer of the product, not generated patch notes.
-* infer what the product does
-* infer who the users are
-* identify the overall theme of the release
-* understand what users will notice or benefit from
+The changelog should feel:
-Write release notes like a human developer.
+* natural
+* concise
+* intentional
+* polished
+* human
-The changelog should:
+Focus on:
-* feel natural
-* feel intentional
-* focus on user experience
-* explain what feels better now
-* avoid sounding robotic or corporate
-* avoid sounding like commit messages
+* user-visible changes
+* UI/UX polish
+* smoother interactions
+* reliability improvements
+* clearer behavior
+* meaningful fixes
-Do not expose raw implementation details unless absolutely necessary.
+Use sections only when relevant:
-Ignore:
+## New
+## Changes
+## Improvements
+## Fixes
-* formatting-only changes
-* internal refactors without user impact
-* temporary debug work
-* low-value technical noise
+Bullet structure:
-Group related changes together into meaningful user-facing improvements.
+* every bullet should start with a short bold title
+* the title should summarize the improvement in a human way
+* after the title, explain what feels different now
+* keep descriptions concise but meaningful
+* avoid one-line vague bullets
-Use this structure only when relevant:
+Preferred format:
-## New
+- **Improved Navigation.**
+ The sidebar now adapts better to longer text and page transitions feel smoother when moving between sections.
-New features or capabilities users can actively use.
+- **Better translation support.**
+ The UI responds more cleanly to longer localized text and missing translation values have been filled in across the app.
-## Changes
+Writing style:
-Behavior changes, redesigns, renamed functionality, or workflow adjustments.
+* describe changes from the user's perspective
+* explain what feels better now
+* vary sentence structure naturally
+* keep wording simple and direct
+* avoid repetitive bullet openings
+* avoid em dashes
-## Improvements
+Prefer wording like:
-Polish, responsiveness, usability, reliability, clarity, UI/UX refinements, and quality-of-life improvements.
+* "can now"
+* "feels smoother"
+* "works more reliably"
+* "adapts better"
+* "is easier to use"
-## Fixes
+Avoid wording like:
-Bugs, incorrect behavior, regressions, crashes, failed operations, and edge cases that were resolved.
+* "implemented"
+* "utilized"
+* "enhanced stability"
+* "various fixes and improvements"
-Writing rules:
+Bad examples:
-* keep it concise but meaningful
-* focus on user-visible impact
-* explain why changes matter
-* omit empty sections
-* prefer clarity over hype
-* avoid repetitive sentence structure
-* avoid generic phrases like:
+- Improved performance.
+- Fixed bugs.
+- Enhanced UI responsiveness.
- * "Enhanced stability"
- * "Improved performance"
- * "Various fixes and improvements"
- * "Minor bug fixes"
+Good examples:
-Instead of vague claims, explain what actually feels better.
+- **Smoother scrolling.**
+ Large optimization lists now scroll much more fluidly across the app.
-Examples:
+- **Clearer apply errors.**
+ Error messages now better explain which optimization failed and why.
-* "Scrolling through large optimization lists now feels much smoother."
-* "Error messages are clearer when an optimization fails to apply."
-* "Applying changes is now more reliable when Windows blocks certain operations."
+- **More responsive localization.**
+ Layouts adapt better to longer translated text without breaking navigation or spacing.
-Formatting rules:
+When mentioning contributors:
-* do not use em dashes
-* prefer simple punctuation
-* keep Markdown clean and readable
-* avoid excessive bold text
+* mention them naturally
+* sound appreciative, not corporate
+* keep acknowledgements short and human
-The final result should read like authentic release notes from a polished software product update.
+The final result should feel like authentic release notes from a polished indie software update.
\ No newline at end of file
diff --git a/README.md b/README.md
index 767a8e9..6370c1c 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,7 @@ Every star helps motivate future improvements.
> [!NOTE]
> Available in English, Vietnamese, Traditional Chinese (contributed by [@abc0922001](https://github.com/abc0922001)), Simplified Chinese (contributed by [@wcxu21](https://github.com/wcxu21)), and Russian (contributed by [@Foodhead](https://github.com/Foodhead)).
-> Want to add your language? See [CONTRIBUTING.md](./.github/CONTRIBUTING.md).
+> Want to add your language? See [CONTRIBUTING.md](./CONTRIBUTING.md).
---
diff --git a/README.ru-RU.md b/README.ru-RU.md
index b966e36..a7a4c31 100644
--- a/README.ru-RU.md
+++ b/README.ru-RU.md
@@ -53,7 +53,7 @@
> [!NOTE]
> Доступно на английском, вьетнамском, традиционном китайском (спасибо [@abc0922001](https://github.com/abc0922001)), упрощённом китайском (спасибо [@wcxu21](https://github.com/wcxu21)) и русском (спасибо [@Foodhead](https://github.com/Foodhead)).
-> Хотите добавить свой язык? См. [CONTRIBUTING.md](./.github/CONTRIBUTING.md).
+> Хотите добавить свой язык? См. [CONTRIBUTING.md](./CONTRIBUTING.md).
---
diff --git a/README.vi.md b/README.vi.md
index b8a2c1c..046d196 100644
--- a/README.vi.md
+++ b/README.vi.md
@@ -53,7 +53,7 @@ Mỗi ngôi sao giúp tạo động lực cho những cải tiến trong tương
> [!NOTE]
> Hỗ trợ tiếng Anh, tiếng Việt, tiếng Trung phồn thể (đóng góp bởi [@abc0922001](https://github.com/abc0922001)), tiếng Trung giản thể (đóng góp bởi [@wcxu21](https://github.com/wcxu21)) và tiếng Nga (đóng góp bởi [@Foodhead](https://github.com/Foodhead)).
-> Muốn thêm ngôn ngữ của bạn? Xem [CONTRIBUTING.md](./.github/CONTRIBUTING.md).
+> Muốn thêm ngôn ngữ của bạn? Xem [CONTRIBUTING.md](./CONTRIBUTING.md).
---
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 789fdd0..7738f58 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -53,7 +53,7 @@
> [!NOTE]
> 目前支持英语、越南语、繁体中文(由 [@abc0922001](https://github.com/abc0922001) 贡献)、简体中文(由 [@wcxu21](https://github.com/wcxu21) 贡献)和俄语(由 [@Foodhead](https://github.com/Foodhead) 贡献)。
-> 想要添加其他语言?请查看[贡献指南](./.github/CONTRIBUTING.md)。
+> 想要添加其他语言?请查看[贡献指南](./CONTRIBUTING.md)。
---
diff --git a/README.zh-TW.md b/README.zh-TW.md
index d76f6c6..60624c3 100644
--- a/README.zh-TW.md
+++ b/README.zh-TW.md
@@ -53,7 +53,7 @@
> [!NOTE]
> 目前支援英文、越南文、繁體中文(由 [@abc0922001](https://github.com/abc0922001) 貢獻)、簡體中文(由 [@wcxu21](https://github.com/wcxu21) 貢獻)、及俄文(由 [@Foodhead](https://github.com/Foodhead) 貢獻)。
-> 想加入您的語言嗎?請查看[貢獻指南](./.github/CONTRIBUTING.md)。
+> 想加入您的語言嗎?請查看[貢獻指南](./CONTRIBUTING.md)。
---