Install prettier and run on docs
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 65/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- javascript
- 领域
- ci-cd, documentation, tooling
调研方向
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:
- Install Prettier (branch
prettier, based on #846): addprettieras a dev dependency,yarn format/yarn format:checkscripts, a.prettierignorefor generated and frozen files, and point the skills atyarn prettier --write <files>. No pages change. - Reformat everything (branch
prettier-format-docs, based on PR 1): fix the few source issues Prettier trips on, then one formatting-only commit fromyarn format, listed in.git-blame-ignore-revssogit blameskips 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 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
OpenFn/docs 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
Write documentation for migrating workflow code可能已有人在做 @PiusKariuki 于 2 天前认领。 未关闭P1
维护者通常 1 天内回复
-
Review and update Manage User Credential page可能已有人在做 @mtuchi 于 8 天前认领。 未关闭
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 45/100
维护者通常 1 天内回复
相似的 Issue
-
check:passed feeds:remove
难度 1/5 1 小时以内 新手友好度 65/100
iptv-org/database#37176 · 1 条评论 · 1 个 reaction ·
维护者通常 9 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
hawk-digital-environments/HAWKI#443 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
feedback simulation workshop
难度 2/5 1-3 小时 新手友好度 66/100
githubnext/gh-aw-workshop#4370 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
AltimateAI/vscode-dbt-power-user#2089 ·