We should generate and publish documentation for the Module API using Sphinx

Repository metrics

Stars

11,713 個のスター (11,713 個のスター)

PR merge metrics

PR metrics pending (PR metrics pending)

説明

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

調査方針

Synapse プロジェクトのドキュメント構造と Sphinx 構成を理解し、適切な docstring または RST ファイルを追加して ModuleApi クラスの `get userinfo by id` メソッドを文書化します。

技術スタック

python

領域

backendapi

Issue 種別

ドキュメント

難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。

2

推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。

1-3時間

活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。

アクティブ

明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。

明確

前提条件

PythonSphinxGit

初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。

75