Code blocks are poorly formatted in OpenMetrics.txt

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

@erharjotsingh がすでに取り組んでいます。

2024年4月29日 から。

評価

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

調査の方向性

specification/OpenMetrics.txt の 802~820 行付近を調査し、ドキュメント内で ~~~~ を検索して、影響を受けるコードブロックを一覧化します。次に、Markdown-to-RFC 変換のエントリーポイントを見つけ、チルダで区切られたブロックがどのように処理されるかを確認します。生成された RFC 出力でそれらのブロックがコードとして表示され、他のフォーマットを壊さなければ完了です。

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

説明

For instance:

https://github.com/OpenObservability/OpenMetrics/blob/1386544931307dff279688f332890c31b6c5de36/specification/OpenMetrics.txt#L802-L820

Other code blocks are similarly messed up (search for ~~~~).

It seems the Markdown to RFC converter does not support tilde-delimited code blocks.

主要言語
Go
スター
2.5k
フォーク
175
平均マージ
1日 22時間
マージ済み PR(30日)
1

環境構築

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

はじめの一歩

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

prometheus/OpenMetrics のほかの issue

prometheus/OpenMetrics の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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