Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Install prettier and run on docs

未关闭
#866 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
65/100
Issue 类型
重构
描述清晰度
描述清楚
活跃度
活跃
技术栈
javascript

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

#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.

主要语言
JavaScript
星标
24
派生
21
平均合并
1 天 11 小时
30 天内合并 PR
37

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

OpenFn/docs 的其他 Issue

查看 OpenFn/docs 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。