pyupio/safety

Documentation Improvements

オープン

#572 opened on 2024/08/14

GitHub で見るコントリビューターガイド
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Python (135 件のフォーク)batch import
good first issue

Repository metrics

Stars
 (1,557 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

This issue is intended to encourage continuous improvement of the documentation across the repository. We are looking for contributions that enhance clarity, add examples, or update existing documentation to better reflect current functionality. If you notice an area of the documentation that could benefit from an update or expansion, please feel free to contribute! After making your changes, create a new issue describing what you’ve done and link it to this general documentation improvement issue.

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

調査方針
まず、プロジェクトのREADME、コントリビューションガイド、およびリポジトリ内のその他のドキュメントを確認してください。明確さに欠ける箇所、例が不足している箇所、または古い情報が含まれている箇所を特定します。また、リポジトリのイシュートラッカーをチェックして、具体的なドキュメントリクエストを探すこともできます。改善を行った後、変更内容を説明する新しいイシューを作成し、このイシューにリンクしてください。プロジェクトのドキュメントスタイルとトーンに従ってください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85