Cite the literature: CITATION.cff, a bibliography, and citations in docstrings
メンテナーはふだん 3 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- python
調査の方向性
Start with the root of the repo for a new CITATION.cff, then with AGENTS.md for the rule about introducing references before relying on them. The docs build (zensical, CI) decides which bibliography plugin fits, so check that config before choosing one. Done means CITATION.cff exists and parses, a bibliography file such as docs/references.bib holds the cited papers, and one docstring cites an entry that the docs build renders in CI.
索引モデルが issue の本文から書いたものです。
説明
🌀 Claude: xarray-sql builds on published work: FlashAttention, the Nadaraya–Watson estimator, and DeepMind's GraphCast in the ML demos, along with the database literature behind its query plans. Readers, and agents working on the code, would find it easier to follow and extend that work if the project cited it in one place, and could be cited itself.
Proposal:
- A
CITATION.cffat the root, so GitHub shows "Cite this repository" and tools can read it. - One bibliography (for example
docs/references.bib) of the papers the code and docs rely on. - Citations in docstrings and docs pages, resolved against that file. The docs are built with zensical, which is compatible with MkDocs, so a MkDocs bibliography plugin may work where a Sphinx one wouldn't. Whatever the choice, the docs build needs to be checked with CI's zensical.
The rule in AGENTS.md to introduce every reference before relying on it would then point to the bibliography.
Raised in review of #269.
- 主要言語
- Python
- スター
- 142
- フォーク
- 19
- 平均マージ
- 3日 47分
- マージ済み PR（30日）
- 8
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
xqlsystems/xarray-sql のほかの issue
-
dependencies github_actions
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
xqlsystems/xarray-sql#295 ·
メンテナーはふだん 3 日以内に返信
-
A big-endian data variable registers, then every query fails: Byte-swapped arrays not supportedオープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
xqlsystems/xarray-sql#288 ·
メンテナーはふだん 3 日以内に返信
-
documentation ml
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
xqlsystems/xarray-sql#268 ·
メンテナーはふだん 3 日以内に返信
-
enhancement ml
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
xqlsystems/xarray-sql#267 · コメント 4 件 ·
メンテナーはふだん 3 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 74/100
xqlsystems/xarray-sql#243 ·
メンテナーはふだん 3 日以内に返信
xqlsystems/xarray-sql の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
Textualize/textual#6753 · コメント 1 件 ·
-
priority:low size:small
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
RonaldHensbergen/composable-data-stack#1177 ·
メンテナーはふだん 1 日以内に返信
-
Use registered media types for HDF5 and NetCDF, and stop claiming media_type must be IANA-registeredオープンdocumentation metadata
難易度 2/5 1〜3時間 初心者へのやさしさ 87/100
メンテナーはふだん 1 日以内に返信
-
check-typing: ty 0.0.98+ fails on the renamed rule `unresolved-import` (now `import-not-found`)対応中かも @oberstet が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
crossbario/cfxdb#145 ·