Roadmap
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- markdown, r, yaml
调研方向
Start with the _pkgdown.yml roadmap configuration described in the issue and compare the linked stan-dev/loo pull request 396. Trace how this pkg currently handles website templates and how an Rmd document could be integrated without emitting HTML. Done means an opt-in roadmap supports milestone and issue overrides, exclusions, ordering, and closed-issue marking.
由索引模型根据 Issue 内容生成。
描述
Add a roadmap template like @florence-bockting did for loo: https://github.com/stan-dev/loo/pull/396
This pkg should read a roadmap section in _pkgdown.yml and support overrides per issue for custom descriptions, same for milestones.
Internally the cleanest way of doing this might be to build a custom Rmd which is styled automatically and to wire in some custom classes as needed from Florence's PR. That way actual rendering is purely pkgdown's purview. That is, this pkg shouldn't emit HTML.
Example template:
roadmap:
enabled: true
format: "rmd" # in the future support writing a "qmd"
overrides:
milestones:
# milestone numbers, not their titles, for stable IDs.
"1":
title: "Version 3.0"
description: >
Custom release-level prose.
issues:
# similarly, issue numbers for stable ID
"123":
description: >
Custom issue-level prose.
exclude:
labels:
- "internal*"
- "wontfix"
- "invalid"
issues:
- "124"
- "456"
This would require pkgs to opt-in, would exclude all PRs, exclude closed milestones, and exclude issues with those labels. Closed issues (which aren't filtered out) in an open milestone should be marked and maybe moved to the end, but otherwise included. Issues will be ordered by issue number.
This would be the default, defined in this pkg, and downstream pkgs could, of course, override as needed. All a typical Stan package would need to get the roadmap is:
roadmap:
enabled: true
Of course, they would have to use milestones/labels as well, but the website part would be handled by this pkg.
- 主要语言
- HTML
- 星标
- 0
- 派生
- 0
- 平均合并
- 21 小时 23 分钟
- 30 天内合并 PR
- 4
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
相似的 Issue
-
documentation
难度 1/5 1 小时以内 新手友好度 90/100
fastrevmd-lab/rustmistmcp#161 ·
-
area: cli enhancement
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
neondatabase/agent-skills#139 ·
维护者通常 1 天内回复
-
难度 2/5 1 小时以内 新手友好度 70/100
-
难度 1/5 1 小时以内 新手友好度 92/100
DataTalksClub/machine-learning-zoomcamp#730 ·
维护者通常 2 天内回复