Document `.quarto-source.yml` as a format other tools can rely on
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 72/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- json, rust
調査の方向性
Start by reading the SourceRecord struct and the user guide line that describes .quarto-source.yml; the issue does not give their file paths. Document each field, version handling, preservation of unknown keys, and the specified hash rules, then add a JSON Schema beside the specification. Done means another tool can follow the documented contract and validate records against the schema.
索引モデルが issue の本文から書いたものです。
説明
Description
Context
q2 add writes .quarto-source.yml next to each extension.
Today the format lives in the SourceRecord struct and one line of the user guide.
Other tools can work with the same file.
The development version of Quarto Wizard, the VS Code extension for Quarto extensions, already writes it in the q2 format, so that an extension installed by one tool can be updated by the other.
To follow the format, it has to read the q2 source.
Proposal
Publish a short specification of the record, with a JSON Schema next to it.
It would cover:
- each field and what it means;
- the schema
versionpolicy: what bumps it, and what a reader does with a newer one; - the rule for keys a tool doesn't know: kept as they are on rewrite;
- the hash rules: sha256 of the bytes of each file as they are on disk,
/paths relative to the extension folder, the record itself left out.
Why
Without a written contract, every other tool has to guess, and a change in q2 can break it without notice.
The two following come from that gap:
Benefits
People using q2 can mix tools on one project: install from the command line, update from the editor, or the other way round.
Local edit detection keeps working whichever tool wrote the record.
Tools such as Quarto Wizard can validate against the published schema and follow its changes.
A future official q2 extension for Positron and VS Code could rely on the same specification.
A future q2 update gets a stable base too.
- 主要言語
- Rust
- スター
- 302
- フォーク
- 22
- 平均マージ
- 5時間 2分
- マージ済み PR(30日)
- 213
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
quarto-dev/q2 のほかの issue
-
`dir: rtl` isn't written to `<html>` in HTML output対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
quarto-dev/q2#1219 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
quarto-dev/q2#1188 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
quarto-dev/q2#1179 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
quarto-dev/q2#1133 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
quarto-dev/q2#1103 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
priority: low
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
storytold/photocraft#15350 ·
メンテナーはふだん 1 日以内に返信
-
area:davinci
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ubugeeei-prod/vize#13167 ·
メンテナーはふだん 1 日以内に返信
-
area:ui enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
transit-audio/transit#738 ·
メンテナーはふだん 1 日以内に返信
-
enhancement good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 91/100
hocinehacherouf/liberarr#78 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信