Make it clear that the Windows ZIP download is portable (no installer, not in Apps & Features)

オープン 初心者向け
#1,289 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
半日
初心者へのやさしさ
78/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
github-actions, html, markdown, yaml

調査の方向性

Windows リリースノートのテンプレートは .github/workflows/build.yml(Windows セクション)にあり、インストールとアンインストールのドキュメントは docs/installation.md と docs/Uninstalling-OpenSAK.md です。ユーザーガイドは site/user-guide.html で、site/index.html にはすでに "Portable ZIP" という表記があるため、文言の参照に使えます。完了の条件は、Issue 本文の文言を使った同じポータブル版の注記が、挙げられた各箇所に記載されていることと、アンインストールのドキュメントに %APPDATA%\opensak と Store 版の Documents\opensak フォルダーが明記されていることです。

索引モデルが issue の本文から書いたものです。

説明

area: documentation documentation good first issue OS: windows

A Windows user downloaded OpenSAK-…-Windows.zip from the Releases page and expected a normal installer. In particular, he expected:

the program to go into Program Files,
OpenSAK to show up in Apps & Features (and in uninstall tools such as Revo).

Neither happens, because the ZIP is portable. He concluded something had gone wrong and spent a long time trying to uninstall and reinstall. He also didn’t know that deleting the program folder leaves the settings in %APPDATA%\opensak (hidden by default). Those leftover settings were why the Welcome Wizard didn’t reappear.

The website does say “Portable ZIP” (site/index.html), but the GitHub release notes, which are where users actually download from, only say “Extract All → double-click OpenSAK.exe”. docs/installation.md mentions unzipping but never says the word “portable”.

Proposal

Add a short, consistent note wherever the Windows ZIP is offered:

Portable version: there is no installer. Unzip the folder anywhere you like (Program Files is not needed, and replacing files there requires admin rights). OpenSAK won’t appear in Apps & Features. To uninstall, delete the folder. Your settings and databases are kept in %APPDATA%\opensak (or the folders you chose in the Welcome Wizard). Help → OpenSAK File Locations… shows them all. For a regular install with automatic updates, use the Microsoft Store version.

Places to update:

Release notes template in .github/workflows/build.yml (Windows section)
docs/installation.md (Windows direct download section)
docs/Uninstalling-OpenSAK.md: delete the folder and how to find the data folders, including %APPDATA%\opensak and the Store version’s Documents\opensak
site/user-guide.html (installation section)
Optional: a README.txt inside the ZIP next to OpenSAK.exe with the same text

主要言語
Python
スター
37
フォーク
17
平均マージ
21時間 5分
マージ済み PR(30日)
131

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenSAK-Org/OpenSAK のほかの issue

OpenSAK-Org/OpenSAK の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。