Add the Glossary Term tutorial template (`tutorial-glossary`)
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 76/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- react, typescript
调研方向
Start with src/templates/tutorial/cheat-sheet.ts for the JetBrains Mono panel and src/templates/tutorial/quiz-card.ts for the tutorial layout and readable accent text. Implement the fields and acceptance criteria in src/templates/tutorial/glossary.ts, then re-export it from src/templates/tutorial/index.ts and register it in the Tutorial block of src/templates/registry.ts. Check the shared template checklist in #5; done means the glossary handles long and empty values as specified and is registered.
由索引模型根据 Issue 内容生成。
描述
Part of #5. For "term of the day" posts and docs glossaries.
Idea
A small label sits at the top ("Term of the day"). The term is large under it ("Idempotent"), with an optional part of speech next to it in a muted color ("adjective"). Below is the definition in two or three lines, and an optional example in JetBrains Mono inside a code panel ("PUT /users/42 twice still leaves one user").
Template details
- File:
src/templates/tutorial/glossary.ts, idtutorial-glossary - Fields:
label(text, default "Term of the day"),term(text),partOfSpeech(text, optional),commonFields.description(the definition),example(text, optional),commonFields.bgColor,commonFields.accentColor,commonFields.textColor
Where to look
- Closest reference:
src/templates/tutorial/cheat-sheet.ts(a JetBrains Mono panel),src/templates/tutorial/quiz-card.ts(tutorial layout, and accent text that stays readable on light backgrounds)
Acceptance criteria
- Long terms shrink with
autoFontSize(), and long definitions and examples are truncated - An empty
partOfSpeechorexamplehides cleanly, and a value of only spaces counts as empty - Re-exported in
src/templates/tutorial/index.tsand registered in the Tutorial block ofsrc/templates/registry.ts - Meets the shared template checklist in #5
One template per contributor at a time, so more people get a chance.
Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #234 in the description.
- 主要语言
- TypeScript
- 星标
- 8
- 派生
- 4
- 平均合并
- 5 小时 19 分钟
- 30 天内合并 PR
- 99
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
codercops/ogcops 的其他 Issue
-
good first issue hacktoberfest templates
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
Add the Office Hours event template (`event-office-hours`)可能已有人在做 @bhushan4work 今天认领。 未关闭good first issue hacktoberfest templates
codercops/ogcops#237 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
`npm run dev` keeps serving old images from `/api/og` after a template change可能已有人在做 @srujankaleru2007 今天认领。 未关闭bug good first issue hacktoberfest
codercops/ogcops#228 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Add the Top Episodes podcast template (`podcast-top-episodes`)可能已有人在做 @piyusshhjangid 今天认领。 未关闭good first issue hacktoberfest templates
codercops/ogcops#226 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Add the Sponsor newsletter template (`newsletter-sponsor`)可能已有人在做 @Saumyajaiswal9794 于 1 天前认领。 未关闭good first issue hacktoberfest templates
codercops/ogcops#208 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
相似的 Issue
-
[Bug]: REST API URL starting with "http" but no scheme (e.g. httpbin.org/get) is not given an http:// prefix可能已有人在做 @ItsDeadlyProgrammer 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 68/100
appsmithorg/appsmith#42471 · 1 条评论 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
ehmpathy/rhachet-roles-bhrain#705 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
Status: Triage
难度 2/5 1-3 小时 新手友好度 76/100
mermaid-js/mermaid#8546 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
braintrustdata/braintrust-sdk-javascript#2659 ·
维护者通常 1 天内回复