lchtangen/SampleMind-AI---Beta

Add missing docstrings to utility functions

Open

#1 opened on 2025年10月4日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (2 forks)auto 404
beginnerdocumentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

説明

Description: Add comprehensive docstrings to all functions in the file picker utility.

Tasks:

  • Add docstrings following Google style
  • Include parameter types and return types
  • Add usage examples

File: src/samplemind/utils/file_picker.py

Difficulty: 🟢 Beginner Time: 30-60 minutes

See docs/GOOD_FIRST_ISSUES.md Issue #1 for details.

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

調査方針
Google Python docstringスタイルガイドを確認し、コードベースの既存のdocstringのパターンを調べてください。その後、src/samplemind/utils/file picker.pyのすべての関数に同じスタイルでdocstringを追加してください。
技術スタック
python
領域
backend
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonGoogle style docstrings
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90