astronomy-commons/lsdb

Add a glossary of terms in the documentation

オープン

#949 opened on 2025/07/24

GitHub で見る
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Python (21 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (54 個のスター)
PR merge metrics
 (PR metrics pending)

説明

One pain point brought up from the HCI study was that users were not familiar with the jargon. A suggestion was to add a glossary page in the docs. As a stretch goal, having the terms link to the glossary when they appear in the docs would be a good UX.

コントリビューターガイド

調査方針
既存のドキュメント構造を確認し、用語集を追加する適切な場所を見つけ、コードベースとドキュメントから用語のリストを作成してください。既存ページで用語集へのリンクを提供する方法を検討してください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80