TarekSaeed0/chess

doc: add documentation to chess.h

オープン

#2 opened on 2025/05/26

GitHub で見る
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)C (0 件のフォーク)auto 404
documentationgood first issue

Repository metrics

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

説明

adding Doxygen comments for the various types and functions in chess.h will help with new contributors and users of the library, understand the various types and functions defined and how to use them correctly, as currently the generated documentation is mostly empty.

コントリビューターガイド

調査方針
chess.h を開き、既存の規則に従って各型と関数に Doxygen コメントを追加します。`@param`、`@return`、`@brief` タグを使用してください。
技術スタック
c
領域
backend
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
C
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90