Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

JavaScript style guide for documentation PRs

Đang mở
  • Có gì không ổn?
#397 15 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 5 ngày

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với nội dung issue và chuỗi thảo luận gồm 15 bình luận; không có tệp hoặc bài kiểm thử nào được nêu. Xác định liệu style guide cho các PR tài liệu đã có phạm vi được thống nhất hay chưa, sau đó xác định điểm vào của tài liệu và thống nhất về các danh mục cũng như ví dụ cấu thành việc hoàn tất.

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

Mô tả

@zachleat,

Can we drum up a quick style guide for vanilla JS code examples? I'm willing to forego my (otherwise highly opinionated) personal style for a standard.

I can mimic what's already there, but it'd be good to establish something formally—for consistency within the docs (if not also the codebase). Here are the major categories I'm thinking we could use some clear ground rules:

  • Ternary operators v. conditional statements?
  • Semicolon?
  • Closures?
  • Explicit return statements?
  • var v. const and let?
  • Arrow functions v. declarations v. expressions?
  • When and when not to cache variables
  • Classes v. exports.render
  • Comments and/or JSDoc blocks?
  • import v. require()
  • this
  • Others?

I'm convinced more folks would reach for the vanilla 🍦 if they had more examples in the docs—and I wanna help.

Ngôn ngữ chính
Nunjucks
Star
547
Fork
731
Merge trung bình
5 ngày 11 giờ
Pull request đã merge (30 ngày)
8

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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.

Issue khác của 11ty/docs

Tất cả issue của 11ty/docs

Issue tương tự

Thêm issue về Documentation

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.