plotly / plotly/plotly.js

BUILDING.md: minor typo and some Markdown syntax errors

Ouverte Adaptée aux débutants
#6,930 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug infrastructure P2
Langage dominant
JavaScript
Étoiles
18.3k
Forks
2k
Merge moyen
2 j 12 h
PR mergées (30 j)
28

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Ouvrez BUILDING.md et examinez la ligne précédant le premier en-tête de niveau 1 ainsi que la ligne suivant le dernier paragraphe. Corrigez les problèmes de syntaxe Markdown et remplacez "it's" par "its" dans le premier paragraphe consacré à Angular CLI. La tâche est terminée lorsque la règle horizontale et l'en-tête de paragraphe involontaires ont été supprimés et que la formulation a été corrigée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
65/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.