Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Roadmap

オープン
#16 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
markdown, r, yaml
領域
documentation

調査の方向性

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分
マージ済み PR(30日)
4

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。