Skip to content

docs(readme): add install warnings for snap and winget#1729

Merged
UNIkeEN merged 1 commit into
UNIkeEN:mainfrom
pangbo13:docs/readme-install-warnings
Jun 15, 2026
Merged

docs(readme): add install warnings for snap and winget#1729
UNIkeEN merged 1 commit into
UNIkeEN:mainfrom
pangbo13:docs/readme-install-warnings

Conversation

@pangbo13

@pangbo13 pangbo13 commented Jun 15, 2026

Copy link
Copy Markdown
Collaborator

Checklist

  • Changes have been tested locally and work as expected.
  • All tests in workflows pass successfully.
  • Documentation has been updated if necessary.
  • Code formatting and commit messages align with the project's conventions.
  • Comments have been added for any complex logic or functionality if possible.

This PR is a ..

  • 🆕 New feature
  • 🐞 Bug fix
  • 🛠 Refactoring
  • ⚡️ Performance improvement
  • 🌐 Internationalization
  • 📄 Documentation improvement
  • 🎨 Code style optimization
  • ❓ Other (Please specify below)

Related Issues

Description

增加snap和winget的warning,与官网同步

Additional Context

Summary by Sourcery

Document additional installation warnings for Snap and Winget package sources across all localized READMEs.

Documentation:

  • Add a warning about Snap installs storing game data in sandboxed directories and the need to back up saves and other data before uninstalling.
  • Add a warning about verifying the Winget installer source and URL before installation in English, Simplified Chinese, and Traditional Chinese READMEs.

@sourcery-ai

sourcery-ai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documents new safety warnings for Snap and Winget installation methods across the main and localized READMEs, highlighting sandboxed data for Snap and source verification for Winget.

File-Level Changes

Change Details Files
Add Snap and Winget installation safety warnings to English and Chinese READMEs.
  • Insert a warning block after the Snap install snippet explaining sandboxed game data and advising users to back up saves and mods before uninstalling.
  • Insert a warning block after the Winget install snippet advising users to inspect the installer URL via winget show SJMC.SJMCL and verify it comes from trusted project domains.
  • Mirror the same Snap and Winget warning content in Simplified Chinese and Traditional Chinese documentation, using localized phrasing while preserving meaning.
README.md
docs/README.zh-Hans.md
docs/README.zh-Hant.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 15, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@UNIkeEN
UNIkeEN merged commit 8bf5234 into UNIkeEN:main Jun 15, 2026
2 checks passed
@pangbo13
pangbo13 deleted the docs/readme-install-warnings branch June 15, 2026 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants