PythonBulawayo/ChitChat

Add API Endpoint Documentation

オープン

#23 opened on 2024/01/25

GitHub で見るコントリビューターガイド
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (24 件のフォーク)auto 404
documentationgood first issue

Repository metrics

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

説明

The API is currently undocumented. Add documentation to make it easy to build against the API. We should consider using a tool like Swagger to document our endpoints.

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

調査方針
コードベースを探索してすべてのAPIエンドポイントを特定し、Swaggerなどのドキュメンテーションツールを選択して、各エンドポイントのメソッド、パラメータ、応答例を文書化します。
技術スタック
typescript
領域
apidocumentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75