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

feat: data files (site.Data)

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

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
csharp, json, yaml

调研方向

Start with the existing YAML parser at Fanstatic/Parsers/YAMLParser.cs, then inspect site data loading, serve reload handling, and tests in Fanstatic.Test/ with fixture sites in .TestSites/. Run ./build.sh test and add coverage for site-over-theme precedence, nested YAML/JSON/CSV data, invalid-file errors, and reloads; done means the acceptance template renders the expected score and the documentation is updated.

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

描述

c:content p:high size:S t:feature

Part of the Phase 2 epic (#23).

Current State

There is no data/ directory support; custom data must go into Params. Data files are required for render hooks
and content adapters (Phase 3), e.g. a data/ratings.yaml for [Pentiment](_rating) links.

Tasks:
  • Load data/**/*.{yaml,yml,json} from the site and the theme (site wins) into site.Data, nested by folder and
    file name (data/games/ratings.yaml → site.Data.games.ratings)
  • CSV support (first row = headers → list of dictionaries)
  • JSON via System.Text.Json; YAML via the existing parser (Fanstatic/Parsers/YAMLParser.cs)
  • Clear error with file name on invalid data
  • serve: reload on data change
  • Document on the docs site

Tests live in Fanstatic.Test/ (xUnit + NSubstitute); fixture sites in .TestSites/. Run ./build.sh test; new/changed methods need CRAP ≤ 15 and ≥ 75 % line coverage.

Acceptance Criteria:
  • {{ site.Data.games.ratings["Pentiment"].score }} renders on a fixture site.
Related:
  • #23 (Phase 2 epic, parent)
主要语言
C#
星标
1
派生
0
平均合并
13 小时 50 分钟
30 天内合并 PR
3

环境准备

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

从这里开始

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

MASS4ORG/Fanstatic 的其他 Issue

查看 MASS4ORG/Fanstatic 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

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