fix(generator): correct struct tag for subproject_leads in Leadership struct
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 25/100
Research direction
The bad tag is on the SubprojectLeads field of the Leadership struct in generator/readme_app.go, and the schema notes are in generator/README.md. Check that SubprojectLeadership already uses the snake_case subproject_leads tag, then correct the field's tag. Done means a subproject_leads key in tags.yaml unmarshals into the field and shows in the toc_subproject_readme.tmpl output. Pull request #2330 is already open against this, so check it before starting.
Written by the indexing model from the issue text.
Description
Summary
The Leadership struct in generator/readme_app.go defines SubprojectLeads with an invalid YAML tag: yaml:"Subpproject Leads".
Problem & Impact
- Typo and casing mismatch: The tag contains a duplicate 'p' (
Subpproject) and a space, instead of snake_casesubproject_leads. - Silent Unmarshaling Failure: In Go,
yaml.Unmarshalrelies on struct tags to map YAML keys to struct fields. Because of this tag mismatch, any TOC Subproject specifyingsubproject_leadsintags.yamlfails to unmarshal intoLeadership.SubprojectLeads. - Template Rendering Failure: When
toc_subproject_readme.tmplevaluates:{{- if .Leadership.SubprojectLeads }} ### Subproject Leads {{- range .Leadership.SubprojectLeads }} ....Leadership.SubprojectLeadsis always nil, causing subproject leads to be silently dropped from generated README files. - In
generator/README.md, the schema documentation already explicitly specifiessubproject_leads:, andSubprojectLeadership(line 24) correctly usesyaml:"subproject_leads".
Proposed Fix
- Update
SubprojectLeadstag ingenerator/readme_app.gotoyaml:"subproject_leads,omitempty". - Clean up step numbering and remove stale TODO comment in
generator/README.md.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 728
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 10
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cncf/toc
-
kind/review needs-triage review/health toc
Difficulty 5/5 Over a week Newbie friendliness 5/100
Maintainers usually reply within 1 day
-
kind/initiative needs-group needs-triage
Difficulty 5/5 Over a week Newbie friendliness 18/100
Maintainers usually reply within 1 day
-
[Initiative]: Telco AI NativePossibly taken @kashifest claimed this 11 days ago. Openkind/initiative tag/infrastructure triage/valid
Difficulty 5/5 Over a week Newbie friendliness 20/100
cncf/toc#2314 · 14 comments · 2 reactions · 1 assignee ·
Maintainers usually reply within 1 day
-
kind/initiative needs-group needs-triage
Difficulty 5/5 Over a week Newbie friendliness 30/100
Maintainers usually reply within 1 day
-
[LEVEL CHANGE] Meshery Sandbox to IncubationMay be free again @riaankleinhans claimed this 35 days ago, and no pull request is open. Openkind/moving-levels toc triage/valid
cncf/toc#2302 · 1 reaction · 1 assignee ·
Maintainers usually reply within 1 day
Similar issues
-
area:devenv origin:agent type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
overengineeringstudio/effect-utils#1949 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 70/100
EclipseFdn/open-vsx.org#14421 ·
Maintainers usually reply within 1 day