plotly / plotly/plotly.js

BUILDING.md: minor typo and some Markdown syntax errors

Đang mở Phù hợp với người mới
#6,930 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

bug infrastructure P2
Ngôn ngữ chính
JavaScript
Star
18.3k
Fork
2k
Merge trung bình
2 ngày 12 giờ
Pull request đã merge (30 ngày)
28

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Mở BUILDING.md và kiểm tra dòng trước tiêu đề cấp 1 đầu tiên cũng như dòng sau đoạn văn cuối cùng. Sửa các vấn đề về cú pháp Markdown và đổi "it's" thành "its" trong đoạn văn Angular CLI đầu tiên. Hoàn tất khi đường kẻ ngang ngoài ý muốn và tiêu đề đoạn văn được xóa, đồng thời cách diễn đạt được sửa lại.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
markdown
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
65/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.