InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Formatting of newlines in gitbook
まだ誰も着手していません。
- 主要言語
- HTML
- スター
- 853
- フォーク
- 206
- 平均マージ
- 1日 23時間
- マージ済み PR(30日)
- 2
説明
gitbook is the tool that we use to host https://patterns.innersourcecommons.org.
gitbook has (recently) changed the way that newline characters (\n) in our markdown files are rendered.
Previously a single newline character did not generate a line break.
That meant that we could format our pattern files like below to allow for easier line-based commenting when reviewing patterns.
There's a central project that everyone depends on.
What a great candidate for InnerSource!
Unfortunately, the project has grown organically, with various contributions and additions slapped on haphazardly.
Recently gitbook made change in this rendering logic. Now such text in markdown is rendered exactly as shown i.e. each newline in the markdown also leads to a line break in the rendered HTML. This does not look great. See screenshot below.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、pattern markdown ファイルと issue で説明されている GitBook でレンダリングされたページを確認し、単一の改行文字がどのように扱われるかを確かめます。修正が markdown の内容と GitBook の設定のどちらに属するのかを特定し、その後、レンダリングされた pattern に意図しない改行が表示されなくなり、意図した段落が維持されていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- markdown
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100