[DOCS] EOL Policy

オープン
#28 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

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

調査の方向性

Start by reviewing hardware-software.md and the support page linked in the issue to see how requirements, versioning, and changelogs are currently documented. Write an explicit EOL policy guide from the policy details in the issue, and consider whether a support matrix is needed. Done means the guide clearly documents deprecation notice, fixes, breaking changes, connector support, and manual support timelines.

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

説明

We should have an explicit EOL policy guide and, potentially, an explicit support matrix. We can then move version numbers out of other docs.

Currently available:

Graphistry EOL policy is:

  • API deprecation:
    -- Avoid most deprecations by making new APIs additive vs. breaking
    -- Aim for 1+ year notification window when unavoidable
    -- Ex: We still support our 1.0 REST protocol, and are only now moving to officially deprecate it
  • Fixes go into new versions (vs. LTS patching)
  • Document breaking changes in the release changelog, as well as significant internal infra upgrades
  • Connectors: Latest major version of a product; we will be revisiting in Q2/Q3 for supporting multi-major-versions (e.g., we support both Neo4j 3 + Neo4j 4)
  • Manual support: 2yr old version for enterprise, 1yr old for cloud
主要言語
Shell
スター
31
フォーク
6
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

graphistry/graphistry-cli のほかの issue

graphistry/graphistry-cli の issue をすべて見る

似ている issue

Shell/Bash の issue をもっと見る

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

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