Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add the Glossary Term tutorial template (`tutorial-glossary`)

Đã đóng
#234 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@srikar-naidu đang làm issue này rồi.

Từ ngày 24/10/2026.

  • #244 của @srikar-naidu — đã merge

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
76/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
react, typescript
Lĩnh vực
design, frontend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

good first issue hacktoberfest templates

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, id tutorial-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 partOfSpeech or example hides cleanly, and a value of only spaces counts as empty
  • Re-exported in src/templates/tutorial/index.ts and registered in the Tutorial block of src/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.

Ngôn ngữ chính
TypeScript
Star
8
Fork
4
Merge trung bình
5 giờ 15 phút
Pull request đã merge (30 ngày)
102

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của codercops/ogcops

Tất cả issue của codercops/ogcops

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.