Documentation sources are not linted in CI
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 64/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions, markdown
- 领域
- ci-cd, documentation
调研方向
从 .github/workflows/docs-pull-request.yml 开始，然后检查 docs/Makefile 中的 lint 目标以及 .pre-commit-config.yaml 中的 prettier hook。运行现有的文档 lint 检查，解决 docs/ 下当前的格式和 Markdown 问题，并验证包含 lint 缺陷的文档 pull request 会在 CI 中失败。
由索引模型根据 Issue 内容生成。
描述
Documentation pull requests pass CI with formatting and Markdown quality defects which should be caught before review. The docs CI workflow only builds the site (.github/workflows/docs-pull-request.yml); the existing lint Makefile target (docs/Makefile) and the repository pre-commit prettier hook (.pre-commit-config.yaml) are never run by CI. As a result, the current documentation sources already fail formatting on 151 files and carry thousands of Markdown lint findings.
Acceptance criteria
- All current documentation sources under
docs/pass formatting and Markdown lint checks. - A documentation pull request that introduces a formatting or Markdown lint defect fails CI.
- 主要语言
- Python
- 星标
- 7.1k
- 派生
- 603
- 平均合并
- 3 天 8 小时
- 30 天内合并 PR
- 102
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Flagsmith/flagsmith 的其他 Issue
-
Expose whether an organisation is blocked for API usage可能已有人在做 @PiUnknown 于 26 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 62/100
Flagsmith/flagsmith#8773 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
Environment colors mismatch in audit log view可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 85/100
Flagsmith/flagsmith#8681 · 1 条评论 ·
维护者通常 1 天内回复
-
influx_query_manager doesn't catch ApiException, so Influx error responses 500可能已有人在做 @SAY-5 于 1 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
Flagsmith/flagsmith#8510 · 1 条评论 ·
维护者通常 1 天内回复
-
Sales dashboard: download_org_data 500s with "Object of type generator is not JSON serializable"可能已有人在做 @Iflaqbhat 于 46 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 86/100
维护者通常 1 天内回复
查看 Flagsmith/flagsmith 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 62/100
openvinotoolkit/openvino_notebooks#3858 ·
维护者通常 1 天内回复
-
bug
难度 1/5 1 小时以内 新手友好度 88/100
hummingbot/hummingbot-api#256 ·
-
bug
难度 2/5 1-3 小时 新手友好度 80/100
-
area:other help wanted
难度 2/5 1-3 小时 新手友好度 70/100
WingedGuardian/GENesis-AGI#4734 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
peach-mitao/peach#693 ·
维护者通常 1 天内回复