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

Install prettier and run on docs

Đang mở
  • Có gì không ổn?
#866 0 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 1 ngày

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
65/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript
Lĩnh vực
ci-cd, documentation, tooling

Hướng nghiên cứu

Start by reviewing #846 and the existing Yarn scripts, then implement the first step on the prettier branch: dependency, format scripts, .prettierignore, and the skills' command. After that lands, use yarn format on the docs, address source issues it exposes, record the formatting commit in .git-blame-ignore-revs, and consider the test-deploy.yml check.

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

Mô tả

#846 is adding some skills to do some automatic translations. Some of these skills run Prettier.

We need to run Prettier on the entire docs project and make sure PRs are easy to review. Make sure no regressions are added.

This is split into two PRs so each one is easy to review:

  1. Install Prettier (branch prettier, based on #846): add prettier as a dev dependency, yarn format / yarn format:check scripts, a .prettierignore for generated and frozen files, and point the skills at yarn prettier --write <files>. No pages change.
  2. Reformat everything (branch prettier-format-docs, based on PR 1): fix the few source issues Prettier trips on, then one formatting-only commit from yarn format, listed in .git-blame-ignore-revs so git blame skips it.

Could do
Formalise prettier and add a CI check (yarn format:check in test-deploy.yml), once PR 2 has landed.

Ngôn ngữ chính
JavaScript
Star
24
Fork
21
Merge trung bình
1 ngày 11 giờ
Pull request đã merge (30 ngày)
37

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

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có 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.

Issue khác của OpenFn/docs

Tất cả issue của OpenFn/docs

Issue tương tự

Thêm issue về JavaScript

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.