plotly / plotly/plotly.js

BUILDING.md: minor typo and some Markdown syntax errors

オープン 初心者向け
#6,930 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

bug infrastructure P2
主要言語
JavaScript
スター
18.3k
フォーク
2k
平均マージ
2日 12時間
マージ済み PR(30日)
28

説明

Markdown interprets a line composed of three or more dashes as a horizontal rule if the prior line is blank. A line of one or more dashes preceded by a non-blank line makes that prior line a level-1 header.

In BUILDING.md, there's a line of three dashes immediately preceding the first level-1 header (Angular CLI), which is interpreted as a horizontal rule. I'm not convinced that was intended. More serious is the fact that the final paragraph is immediately followed by a line of three dashes, making the entire paragraph a level-1 header — a definite mistake.

Additionally, the first paragraph of Angular CLI uses "it's" where "its" should be used.

I can create a PR if that would help.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

調査の方向性

BUILDING.md を開き、最初のレベル 1 見出しの前の行と、最後の段落の後の行を確認します。Markdown の構文上の問題を修正し、最初の Angular CLI の段落で "it's" を "its" に変更します。意図しない水平線と段落見出しが削除され、文言が修正されれば完了です。

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

評価

技術スタック
markdown
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
65/100

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

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