UTDNebula/utd-trends

[Internal]: Add documentation to the React StyleGuide for Common components

開放

#489 建立於 2025年9月3日

在 GitHub 查看貢獻者指南
 (3 則留言) (0 個反應) (1 位負責人)TypeScript (35 個分叉)auto 404
Good First IssueStatus: On HoldType: Documentation

倉庫指標

星標
 (28 顆星)
PR 合併指標
 (平均合併 16天 20小時) (30 天內合併 1 個 PR)

描述

Add documentation to the page for the components in our React StyleGuideIst. For a reference, see the documentation for the Carousel component. See https://github.com/UTDNebula/utd-trends/issues/182#issue-2498557609 for more info about the styleguide.

Components in this sub-issue: Github Button SingleGradesInfo SingleProfInfo Split StickySide WhatsNew

貢獻者指南

研究方向
查看 Carousel 元件文件 (http://localhost:6060/#/Navigation%20Components?id=carousel) 作為模板。然後按照相同的風格和結構為列出的每個元件（Github Button、SingleGradesInfo、SingleProfInfo、Split、StickySide、WhatsNew）編寫文件。
技術棧
react
領域
frontenddocumentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85