Fill out the documentation

オープン
#27 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

ファイル、テスト、エントリーポイントは指定されていません。まずプロジェクトを調査し、ユーザー向けのワークフロー、How-to のトピック、自動 API ドキュメントに必要な docstring を特定してください。ユーザーガイドと How-to が作成され、docstring が完成し、ドキュメントが Read the Docs で公開された時点で作業は完了です。

索引モデルが issue の本文から書いたものです。

説明

Write user guide, some how-tos and finish the docstrings for automatic API documentation.

Release on Readthedocs.

主要言語
Python
スター
2
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

DiamondLightSource/python-tristan のほかの issue

DiamondLightSource/python-tristan の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。