Skip to content

docs: add security policy and clarify support/network boundaries#36

Merged
harumiWeb merged 2 commits intomainfrom
copilot/add-security-md-support-scope
Apr 7, 2026
Merged

docs: add security policy and clarify support/network boundaries#36
harumiWeb merged 2 commits intomainfrom
copilot/add-security-md-support-scope

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 7, 2026

This updates the user-facing docs so first-time users can quickly understand how to report security issues, which platforms are supported, and what network activity to expect from update checks. It separates the security reporting policy from the README while making the support boundary easier to scan.

  • Security policy

    • add SECURITY.md as the primary source for vulnerability reporting
    • document private disclosure via harumiweb.security@gmail.com
    • state best-effort response expectations
    • define supported-version policy in terms of the latest and very recent releases
  • Platform / support scope

    • add a concise Support Policy section to README.md and README.en.md
    • explicitly list Windows / macOS / Linux as supported OSes
    • clarify that audio playback is supported on macOS / Windows
    • clarify that Linux remains usable for learning without audio
    • note that support scope may change over time
  • Network / update checks

    • add a clearer Network / 更新チェック / Network / Update Checks summary in both READMEs
    • state that normal study flows are local-first and offline-capable
    • clarify that update checks are optional and non-blocking
    • briefly describe the network payload as lightweight latest-release metadata
    • call out offline / timeout behavior and the existing disable switch

Example of the added policy surface:

## Support Policy

- supported operating systems are Windows, macOS, and Linux
- audio playback currently targets macOS and Windows
- on Linux, the core learning features remain available without audio playback

## Network / Update Checks

- update checks are optional helper behavior
- the request is only used to fetch lightweight release metadata such as the latest version and release URL
- timeouts and offline failures are skipped silently so they do not interrupt study sessions

Open with Devin

@codacy-production
Copy link
Copy Markdown

codacy-production bot commented Apr 7, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Agent-Logs-Url: https://github.com/harumiWeb/eitango/sessions/46cb8972-4285-413c-83c1-5f1b7d0e9e19

Co-authored-by: harumiWeb <164025931+harumiWeb@users.noreply.github.com>
Copilot AI changed the title [WIP] Add SECURITY.md and clarify support scope docs: add security policy and clarify support/network boundaries Apr 7, 2026
Copilot AI requested a review from harumiWeb April 7, 2026 23:07
@harumiWeb harumiWeb marked this pull request as ready for review April 7, 2026 23:07
Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@harumiWeb harumiWeb merged commit 99e934f into main Apr 7, 2026
8 checks passed
@harumiWeb harumiWeb deleted the copilot/add-security-md-support-scope branch April 7, 2026 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: SECURITY.md とサポート範囲の明文化を追加する

2 participants