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 合并指标
 (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