UTDNebula/utd-trends

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

オープン

#489 opened on 2025/09/03

GitHub で見るコントリビューターガイド
 (3 件のコメント) (0 件のリアクション) (1 人の担当者)TypeScript (35 件のフォーク)auto 404
Good First IssueStatus: On HoldType: Documentation

Repository metrics

Stars
 (28 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85