BUILDING.md: minor typo and some Markdown syntax errors
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Open BUILDING.md and inspect the line before the first level-1 header and the line after the final paragraph. Correct the Markdown syntax issues and change "it's" to "its" in the first Angular CLI paragraph. Done means the unintended horizontal rule and paragraph header are removed and the wording is corrected.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 28
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from plotly/plotly.js
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
chore P1 plotly-internal size: 1 task
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
chore P3 plotly-internal size: 1 task
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
feature good for agent P2 size: 3
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
All issues in plotly/plotly.js
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·