docs: define versioning, deprecation, and support policy

クローズ 初心者向け
#46 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

@devops-thiago がすでに取り組んでいます。

2026年10月18日 から。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
領域
documentation

調査の方向性

まず SECURITY.md を確認し、既存のサポートに関する記述を特定してください。提案されているセマンティックバージョニングの方針、公開互換性契約、非推奨化のプロセス、およびセキュリティ修正を受け取るバージョンを文書化してください。運用担当者がこれらのポリシーを SECURITY.md で見つけられる状態になれば完了です。

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

説明

documentation
Problem Statement

SECURITY.md lists only "latest" as supported, and there is no documented versioning or deprecation policy. For a project asking operators to deploy and upgrade in place, the compatibility promise (config keys, image names, schema, webhook behavior) and how breaking changes are signaled need to be explicit.

Proposed Solution

Document a versioning and support policy: semantic-versioning commitments, what counts as the public contract (env/thrillhousebot.* config, image tags, DB schema, webhook behavior), a deprecation process, and which versions receive security fixes. Update SECURITY.md accordingly.

Alternatives Considered
  • Leave it implicit — risky for operators relying on stability.
Priority

Nice to have

Code of Conduct
  • I have searched for existing issues and this is not a duplicate.
主要言語
Java
スター
35
フォーク
7
平均マージ
7時間 31分
マージ済み PR(30日)
193

環境構築

はじめの一歩

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

devops-thiago/ThrillhouseBot のほかの issue

devops-thiago/ThrillhouseBot の issue をすべて見る

似ている issue

Java の issue をもっと見る

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

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