plotly / plotly/plotly.js

BUILDING.md: minor typo and some Markdown syntax errors

Aberta Para iniciantes
#6,930 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

bug infrastructure P2
Linguagem predominante
JavaScript
Estrelas
18.3k
Forks
2k
Merge médio
2d 12h
PRs com merge (30d)
28

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Abra BUILDING.md e inspecione a linha antes do primeiro cabeçalho de nível 1 e a linha depois do parágrafo final. Corrija os problemas de sintaxe do Markdown e altere "it's" para "its" no primeiro parágrafo do Angular CLI. A tarefa estará concluída quando a regra horizontal não intencional e o cabeçalho de parágrafo forem removidos e a redação for corrigida.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
markdown
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
Menos de uma hora
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
65/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.